Class Tile`Abstract`

A Tile is, essentially, code to create an Arrow RecordBatch and to associate metadata with it, in the context of a larger dataset.

Hierarchy

Tile
- QuadTile
- ArrowTile

Constructors

constructor

new Tile(dataset: Dataset<Tile>): Tile
Parameters
- dataset: Dataset<Tile>
Returns Tile
- Defined in src/tile.ts:57

Properties

`Optional` __schema

__schema?: schema_entry[]

`Optional` _batch

_batch?: RecordBatch<any>

`Optional` _buffer_manager

_buffer_manager?: TileBufferManager<Tile>

_children

_children: Tile[] = []

`Optional` _download

_download?: Promise<void>

`Optional` _extent

_extent?: {
x: MinMax;
y: MinMax;
}

Type declaration

x: MinMax
y: MinMax

`Optional` _highest_known_ix

_highest_known_ix?: number

`Optional` _max_ix

_max_ix?: number

`Optional` _min_ix

_min_ix?: number

`Abstract` codes

codes: [number, number, number]

dataset

dataset: Dataset<Tile>

download_state

download_state: string

`Readonly` key

key: string

max_ix

max_ix: number = -1

numeric_id

numeric_id: number

parent

parent: Tile

promise

promise: Promise<void>

ready

ready: boolean

`Private` transformation_holder

transformation_holder: Record<string, Promise<void>> = {}

Accessors

`Protected` _schema

get _schema(): number[] | schema_entry[]
Returns number[] | schema_entry[]
- Defined in src/tile.ts:272

children

get children(): this[]
Returns this[]
- Defined in src/tile.ts:73

extent

get extent(): Rectangle
Returns Rectangle
- Defined in src/tile.ts:335

highest_known_ix

get highest_known_ix(): number
Returns number
- Defined in src/tile.ts:233
set highest_known_ix(val: number): void
Parameters
- val: number
Returns void
- Defined in src/tile.ts:222

min_ix

get min_ix(): number
Returns number
- Defined in src/tile.ts:245

record_batch

get record_batch(): RecordBatch<any>
Returns RecordBatch<any>
- Defined in src/tile.ts:237

root_extent

get root_extent(): Rectangle
Returns Rectangle
- Defined in src/tile.ts:349

Methods

[iterator]

[iterator](): IterableIterator<StructRowProxy<any>>
Returns IterableIterator<StructRowProxy<any>>
- Defined in src/tile.ts:345

add_column

add_column(name: string, data: Float32Array): RecordBatch<any>
Parameters
- name: string
- data: Float32Array
Returns RecordBatch<any>
- Defined in src/tile.ts:125

apply_transformation

apply_transformation(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
- Defined in src/tile.ts:105

delete_column_if_exists

delete_column_if_exists(colname: string): void
Parameters
- colname: string
Returns void
- Defined in src/tile.ts:81

download

download(): Promise<void>
Returns Promise<void>
- Defined in src/tile.ts:77

extend_promise

extend_promise(callback: (() => Promise<void>)): Promise<void>
Returns
A promise that includes the callback and all previous promises.
Parameters
- callback: (() => Promise<void>)
  
  A function (possibly async) to execute before this cell is ready.
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>
- Defined in src/tile.ts:266

forEach

forEach(callback: ((p: StructRowProxy<any>) => void)): void
Parameters
- callback: ((p: StructRowProxy<any>) => void)
  - - (p: StructRowProxy<any>): void
    - Parameters
      
      p: StructRowProxy<any>
      
      Returns void
Returns void
- Defined in src/tile.ts:213

get_column

get_column(colname: string): Promise<Vector<any>>
Parameters
- colname: string
Returns Promise<Vector<any>>
- Defined in src/tile.ts:88

is_visible

is_visible(max_ix: number, viewport_limits: Rectangle): boolean
Parameters
- max_ix: number
- viewport_limits: Rectangle
Returns boolean
- Defined in src/tile.ts:130

points

points(bounding: Rectangle, sorted?: boolean): Iterable<StructRowProxy<any>>
Parameters
- bounding: Rectangle
- sorted: boolean = false
Returns Iterable<StructRowProxy<any>>
- Defined in src/tile.ts:156

schema

schema(): Promise<number[] | schema_entry[]>
Returns Promise<number[] | schema_entry[]>
- Defined in src/tile.ts:255

yielder

yielder(): Generator<StructRowProxy<any>, void, unknown>
Returns Generator<StructRowProxy<any>, void, unknown>
- Defined in src/tile.ts:327

Class TileAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

dataset: Dataset<Tile>

Returns Tile

Properties

Optional __schema

Optional _batch

Optional _buffer_manager

_children

Optional _download

Optional _extent

Type declaration

x: MinMax

y: MinMax

Optional _highest_known_ix

Optional _max_ix

Optional _min_ix

Abstract codes

dataset

download_state

Readonly key

max_ix

numeric_id

parent

promise

ready

Private transformation_holder

Accessors

Protected _schema

Returns number[] | schema_entry[]

children

Returns this[]

extent

Returns Rectangle

highest_known_ix

Returns number

Parameters

val: number

Returns void

min_ix

Returns number

record_batch

Returns RecordBatch<any>

root_extent

Returns Rectangle

Methods

[iterator]

Returns IterableIterator<StructRowProxy<any>>

add_column

Parameters

name: string

data: Float32Array

Returns RecordBatch<any>

apply_transformation

Parameters

name: string

Returns Promise<void>

delete_column_if_exists

Parameters

colname: string

Returns void

download

Returns Promise<void>

extend_promise

Returns

Parameters

callback: (() => Promise<void>)

Returns Promise<void>

Returns Promise<void>

forEach

Parameters

callback: ((p: StructRowProxy<any>) => void)

Class Tile`Abstract`

`Optional` __schema

`Optional` _batch

`Optional` _buffer_manager

`Optional` _download

`Optional` _extent

`Optional` _highest_known_ix

`Optional` _max_ix

`Optional` _min_ix

`Abstract` codes

`Readonly` key

`Private` transformation_holder

`Protected` _schema