Class DataSelection<T>

Type Parameters

T extends Tile

Hierarchy

DataSelection

Constructors

constructor

new DataSelection<T>(plot: default<T>, params: IdSelectParams | BooleanColumnParams | FunctionSelectParams | CompositeSelectParams<T>): DataSelection<T>
Type Parameters
- T extends Tile<T>
Parameters
- plot: default<T>
- params: IdSelectParams | BooleanColumnParams | FunctionSelectParams | CompositeSelectParams<T>
Returns DataSelection<T>
- Defined in src/selection.ts:301

Properties

complete

complete: boolean = false

Has the selection run on all tiles in the dataset?

composition

composition: Composition<T> = null

cursor

cursor: number = 0

The cursor is an index that points to the current position within the selected points in the Scatter plot.

dataset

dataset: Dataset<T>

evaluationSetSize

evaluationSetSize: number = 0

The total number of points that have been evaluated for the selection.

This is supplied because deepscatter doesn't evaluate functions on tiles untile they are loaded.

`Private` events

events: {
[key: string]: ((args: any) => void)[];
} = {}

Type declaration

[key: string]: ((args: any) => void)[]

match_count

match_count: number[] = []

name

name: string

name: The name of the selection. This will be used as the colun name in the Arrow record batches and are necessary for users to define so that they can use the selection in subsequent plotAPI calls to apply aesthetics to the selection.

They must be globally unique in the session.

e.g. 'search: fish', '54-abcdf', 'selection at 07:34:12', 'selección compuesta número 1'

plot

plot: default<T>

ready

ready: Promise<void>

Has the selection been applied to the dataset (does not mean it has been applied to all points.)

selectionSize

selectionSize: number = 0

The total number of points in the selection. It is used to know the size of the selected data.

tiles

tiles: T[] = []

`Optional` type

type?: string

Optionally, a user-defined for defining.

If you're using this, I recommend defining your own application schema but I'm not going to force you throw type hints right now because, you know. I'm not a monster.

e.g.: ['search', 'lasso', 'random', 'cherry-pick']

Accessors

ordering

get ordering(): void
Returns void
- Defined in src/selection.ts:577

totalSetSize

get totalSetSize(): number
The total number of points in the set. At present, always a light wrapper around the total number of points in the dataset.

Returns number
- Defined in src/selection.ts:628

Methods

[iterator]

[iterator](): Generator<StructRowProxy<any>, void, unknown>
Returns Generator<StructRowProxy<any>, void, unknown>
- Defined in src/selection.ts:678

addPoints

addPoints(name: any, ixes: BigInt[]): Promise<DataSelection<T>>
Parameters
- name: any
- ixes: BigInt[]
Returns Promise<DataSelection<T>>
- Defined in src/selection.ts:431

add_boolean_column

add_boolean_column(name: string, field: string): Promise<void>
Parameters
- name: string
- field: string
Returns Promise<void>
- Defined in src/selection.ts:714

add_function_column

add_function_column(name: string, tileFunction: BoolTransformation<T>): Promise<void>
Parameters
- name: string
  
  the name for the column to assign in the dataset.
- tileFunction: BoolTransformation<T>
  
  The transformation to apply
Returns Promise<void>
- Defined in src/selection.ts:585

add_identifier_column

add_identifier_column(name: string, codes: number[] | string[] | bigint[], key_field: string, options?: IdentifierOptions): Promise<void>
Parameters
- name: string
- codes: number[] | string[] | bigint[]
- key_field: string
- options: IdentifierOptions = {}
Returns Promise<void>
- Defined in src/selection.ts:689

`Private` add_or_remove_points

add_or_remove_points(name: any, ixes: BigInt[], which: "add" | "remove"): Promise<DataSelection<T>>
Parameters
- name: any
- ixes: BigInt[]
- which: "add" | "remove"
Returns Promise<DataSelection<T>>
- Defined in src/selection.ts:505

applyToAllLoadedTiles

applyToAllLoadedTiles(): Promise<void>
Ensures that the selection has been evaluated on all tiles loaded in the dataset. This is useful if, for example, your selection represents a search, and you are zoomed in on one portion of the map; this will immediately execute the search (subject to delays to avoid blocking the main thread) on all tiles that have been fetched even if out of the viewport.

Resolves upon completion.

Returns Promise<void>
- Defined in src/selection.ts:359

applyToAllTiles

applyToAllTiles(): Promise<void>
Downloads all unloaded tiles in the dataset and applies the transformation to them. Use with care! For > 10,000,000 point datasets, if called from Europe this may cause the transatlantic fiber-optic internet backbone cables to melt.

Returns Promise<void>
- Defined in src/selection.ts:377

apply_to_foreground

apply_to_foreground(params: BackgroundOptions): Promise<void>
Parameters
- params: BackgroundOptions
Returns Promise<void>
- Defined in src/selection.ts:718

`Private` dispatch

dispatch(event: string, args: any): void
Parameters
- event: string
- args: any
Returns void
- Defined in src/selection.ts:341

export

export(fields: string[], format?: "json"): Promise<{
[k: string]: T;
}>
Returns all the data points in the selection, limited to data currently on the screen.
Parameters
- fields: string[]
  
  A list of fields in the data to export.
- format: "json" = "json"
Returns Promise<{
[k: string]: T;
}>
- Defined in src/selection.ts:441

get

get(i: number): StructRowProxy<any>
Returns the nth element in the selection. This is a bit tricky because the selection is stored as a list of tiles, each of which has a list of matches. So we have to iterate through the tiles until we find the one that contains the nth match, then iterate through the matches in that tile until we find the nth match.
Parameters
- i: number
  
  the index of the row to get
Returns StructRowProxy<any>
- Defined in src/selection.ts:642

intersection

intersection(other: DataSelection<T>, name: string): DataSelection<T>
A function that combines two selections into a third selection that is the intersection of the two. Note--for more complicated queries than simple intersection/union, use the (not yet defined) disjunctive normal form constructor.
Parameters
- other: DataSelection<T>
- name: string
Returns DataSelection<T>
- Defined in src/selection.ts:400

moveCursor

moveCursor(by: number): DataSelection<T>
Advances the cursor (the currently selected point) by a given number of rows. steps forward or backward. Wraps from the beginning to the end.

Returns
the selection, for chaining
Parameters
- by: number
  
  the number of rows to move the cursor by
Returns DataSelection<T>
- Defined in src/selection.ts:414

moveCursorToPoint

moveCursorToPoint(point: StructRowProxy<any> | Record<"ix", Number | BigInt>): any
Parameters
- point: StructRowProxy<any> | Record<"ix", Number | BigInt>
Returns any
- Defined in src/selection.ts:462

on

on(event: string, listener: ((args: any) => void)): void
Parameters
- event: string
  
  an internally dispatched event.
- listener: ((args: any) => void)
  
  a function to call back. It takes as an argument the tile that was just added.
  - - (args: any): void
    - Parameters
      
      args: any
      
      Returns void
Returns void
- Defined in src/selection.ts:335

removePoints

removePoints(name: any, ixes: BigInt[]): Promise<DataSelection<T>>
Parameters
- name: any
- ixes: BigInt[]
Returns Promise<DataSelection<T>>
- Defined in src/selection.ts:425

union

union(other: DataSelection<T>, name: string): DataSelection<T>
A function that combines two selections into a third selection that is the union of the two.
Parameters
- other: DataSelection<T>
- name: string
Returns DataSelection<T>
- Defined in src/selection.ts:386

`Private` wrapWithSelectionMetadata

wrapWithSelectionMetadata(functionToApply: BoolTransformation<T>): BoolTransformation<T>
Takes a user-defined supplied transformation and adds some bookkeeping for the various count variables.
Parameters
- functionToApply: BoolTransformation<T>
  
  the user-defined transformation
Returns BoolTransformation<T>
- Defined in src/selection.ts:602

Class DataSelection<T>

Type Parameters

T extends Tile

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Tile<T>

Parameters

plot: default<T>

params: IdSelectParams | BooleanColumnParams | FunctionSelectParams | CompositeSelectParams<T>

Returns DataSelection<T>

Properties

complete

composition

cursor

dataset

evaluationSetSize

Private events

Type declaration

[key: string]: ((args: any) => void)[]

match_count

name

plot

ready

selectionSize

tiles

Optional type

Accessors

ordering

Returns void

totalSetSize

Returns number

Methods

[iterator]

Returns Generator<StructRowProxy<any>, void, unknown>

addPoints

Parameters

name: any

ixes: BigInt[]

Returns Promise<DataSelection<T>>

add_boolean_column

Parameters

name: string

field: string

Returns Promise<void>

add_function_column

Parameters

name: string

tileFunction: BoolTransformation<T>

Returns Promise<void>

add_identifier_column

Parameters

name: string

codes: number[] | string[] | bigint[]

key_field: string

options: IdentifierOptions = {}

Returns Promise<void>

Private add_or_remove_points

Parameters

name: any

ixes: BigInt[]

which: "add" | "remove"

Returns Promise<DataSelection<T>>

applyToAllLoadedTiles

Returns Promise<void>

applyToAllTiles

Returns Promise<void>

apply_to_foreground

Parameters

params: BackgroundOptions

Returns Promise<void>

Private dispatch

Parameters

event: string

`Private` events

`Optional` type

`Private` add_or_remove_points

`Private` dispatch

Returns Promise<{
[k: string]: T;
}>

`Private` wrapWithSelectionMetadata