Class default<T>

The core type of the module is a single scatterplot that manages all data and renderering.

Type Parameters

Hierarchy

  • default

Constructors

constructor

Properties

_renderer? _root? _zoom bound click_handler div elements? handle_highlit_point_change height hooks label_click_handler mark_ready on_zoom? plot_queue prefs ready secondary_renderers selection_history tileProxy? tooltip_handler util width

Accessors

click_function dataset highlit_point_change label_click query root_batch tooltip_html

Methods

add_api_label add_hook add_identifier_column add_labels add_labels_from_url bind contours destroy dim drawContours load_dataset plotAPI reinitialize remove_hook sample_points select_and_plot select_data start_transformations stop_labellers unsafe_plotAPI update_prefs visualize_tiles

Constructors

constructor

  • Type Parameters

    Parameters

    • selector: string

      A DOM selector for the div in which the scatterplot will live.

    • width: number

      The width of the scatterplot (in pixels)

    • height: number

      The height of the scatterplot (in pixels)

    • options: ScatterplotOptions = {}

    Returns default<T>

Properties

Optional _renderer

_renderer?: ReglRenderer<T>

Optional _root

_root?: Dataset<T>

_zoom

_zoom: default<T>

bound

bound: boolean

click_handler

click_handler: ClickFunction

div

div: Selection<any, any, any, any>

Optional elements

elements?: Selection<SVGElement, any, any, any>[]

handle_highlit_point_change

handle_highlit_point_change: ChangeToHighlitPointFunction

height

height: number

Private hooks

hooks: Record<string, Hook> = {}

label_click_handler

label_click_handler: LabelClick

Private mark_ready

mark_ready: (() => void) = ...

Type declaration

    • (): void

    • Returns void

Optional on_zoom

on_zoom?: onZoomCallback

Private plot_queue

plot_queue: Promise<void> = ...

prefs

prefs: CompletePrefs

ready

ready: Promise<void>

Has the scatterplot completed its initial load of the data?

secondary_renderers

secondary_renderers: Record<string, Renderer<T>> = {}

selection_history

selection_history: SelectionRecord<T>[] = []

Optional tileProxy

tileProxy?: TileProxy

tooltip_handler

tooltip_handler: TooltipHTML

util

util: Record<string, ((unknown: any) => unknown)> = ...

width

width: number

Accessors

click_function

dataset

highlit_point_change

label_click

query

root_batch

tooltip_html

Methods

add_api_label

add_hook

  • Hooks provide a mechanism to run arbitrary code after call of plotAPI has resolved. This is useful for--e.g.--updating a legend only when the plot changes.

    Parameters

    • name: string

      The name of the hook to add.

    • hook: Hook

      A function to run after each plot command.

    • unsafe: boolean = false

    Returns void

add_identifier_column

  • Parameters

    • name: string

      The name of the new column to be created. If it already exists, this will throw an error in invocation

    • codes: Record<string, number> | string[] | bigint[]

      The codes to be assigned labels. This can be either a list of ids (in which case all ids will have the value 1.0 assigned) or a keyed of values like {'Rome': 3, 'Vienna': 13} in which case the numeric values will be used.

    • key_field: string

      The field in which to look for the identifiers.

    Returns void

add_labels

  • Parameters

    • features: FeatureCollection<Geometry, {
          [name: string]: any;
      }>

      A geojson feature collection containing point labels

    • name: string

      A unique key to associate with this labelset. Labels can be enabled or disabled using this key.

    • label_key: string

      The text field in which the labels are stored in the geojson object.

    • size_key: string

      A field in the dataset to associate with the size of the labels.

    • options: LabelOptions = {}

    Returns void

add_labels_from_url

  • Parameters

    • url: string
    • name: string
    • label_key: string
    • size_key: string
    • options: LabelOptions

    Returns Promise<void>

bind

  • Parameters

    • selector: string

      A selector for the root element of the deepscatter; must already exist.

    • width: number

      Width of the plot, in pixels.

    • height: number

      Height of the plot, in pixels.

    Returns void

contours

destroy

  • Destroy the scatterplot and release all associated resources. This is necessary because removing a deepscatter instance will not de-allocate tables from GPU memory.

    Returns void

dim

drawContours

  • Parameters

    • contours: any
    • drawTo: any

    Returns void

load_dataset

plotAPI

  • Plots a set of prefs, and returns a promise that resolves upon the completion of the plot (not including any time for transitions).

    Parameters

    Returns Promise<void>

reinitialize

remove_hook

  • Parameters

    • name: string
    • unsafe: boolean = false

    Returns void

sample_points

  • Parameters

    • n: number = 10

    Returns Record<string, string | number>[]

select_and_plot

select_data

start_transformations

  • Get a short head start on transformations. This prevents a flicker when a new data field needs to be loaded onto the GPU.

    Returns

    A promise that resolves immediately if there's no work to do, or after the delay if there is.

    Parameters

    • prefs: APICall

      The API call to prepare.

    • delay: number = 110

      Delay in milliseconds to give the data to get onto the GPU. 110 ms seems like a decent compromise; barely perceptible to humans as a UI response time, but enough time for three animation ticks to run.

    Returns Promise<void>

stop_labellers

Private unsafe_plotAPI

  • This is the main plot entry point: it's unsafe to fire multiple times in parallel because the transition state can get all borked up. plotAPI wraps it in an await wrapper.

    Parameters

    Returns Promise<void>

update_prefs

visualize_tiles

Settings

Member Visibility

Theme

Generated using TypeDoc