Class LabelMaker<T>

Type Parameters

Hierarchy

Constructors

constructor

Properties

_initializations _use_scale_to_download_tiles _zoom? aes? canvas ctx dataset deferred_functions height holder hovered label_key? labelgroup layers options render_props scatterplot timer? tree width zoom?

Accessors

alpha discard_share max_ix optimal_alpha point_size prefs

Methods

bind_zoom delete initialize render start stop update visible_tiles

Constructors

constructor

Properties

_initializations

_initializations: Promise<void>[] = []

_use_scale_to_download_tiles

_use_scale_to_download_tiles: boolean = true

Optional _zoom

_zoom?: default<T>

Optional aes

aes?: AestheticSet<T>

canvas

canvas: HTMLCanvasElement

ctx

ctx: CanvasRenderingContext2D

dataset

dataset: Dataset<T>

deferred_functions

deferred_functions: (() => void | Promise<void>)[]

height

height: number

holder

holder: Selection<any, any, any, any>

Private hovered

hovered: string

Optional label_key

label_key?: string

labelgroup

labelgroup: SVGGElement

layers

layers: GeoJsonObject[] = []

A LabelMaker

options

options: LabelOptions = {}

render_props

render_props: RenderProps = ...

scatterplot

scatterplot: default<T>

Optional timer

timer?: Timer

tree

tree: DepthTree

width

width: number

Optional zoom

zoom?: default<T>

Accessors

alpha

discard_share

  • get discard_share(): number

  • Returns number

max_ix

optimal_alpha

  • get optimal_alpha(): number

  • Returns number

point_size

  • get point_size(): number

  • Returns number

prefs

  • get prefs(): APICall & {
        alpha: number;
        background_options: {
            color: string;
            mouseover: boolean;
            opacity: [number, number];
            size: [number, number];
        };
        duration: number;
        max_points: number;
        point_size: number;
        zoom_balance: number;
    } & {
        arrow_buffer?: Uint8Array;
        arrow_table?: Table<any>;
    }

  • Render prefs are scatterplot prefs, but for a single tile instead of for a whole table.

    Returns APICall & {
        alpha: number;
        background_options: {
            color: string;
            mouseover: boolean;
            opacity: [number, number];
            size: [number, number];
        };
        duration: number;
        max_points: number;
        point_size: number;
        zoom_balance: number;
    } & {
        arrow_buffer?: Uint8Array;
        arrow_table?: Table<any>;
    }

Methods

bind_zoom

delete

initialize

render

start

  • Start rendering a set of labels.

    Parameters

    • ticks: number = 1e9

      How many milliseconds until the renderer should be stopped.

    Returns void

stop

update

  • Parameters

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

      A feature collection of labels to display. Currently each feature must be a Point.

    • label_key: string

      The field in each geojson feature that includes the label for the object.

    • size_key: string

      The field in each geojson feature that includes the size

    Returns void

visible_tiles

Settings

Member Visibility

Theme

Generated using TypeDoc