Class ImageScatterChart

Hierarchy (View Summary)

Constructors

constructor

Properties

__doc__ _tooltip? billboard canvas colorBy? config contentDiv contextMenu dataModel dataStore deck dialogs div extra_legends? height id imageArray isPinned legend legendIcon listeners menuSpace observable opacity progress resetButton saturation settingsDialog? size spaceX spaceY title titleBar unpinIcon? width types

Accessors

dataSource

Methods

_addTrimmedColor _addUnpinIcon _callListeners _getContentDimensions _openSettingsDialog _setConfigValue _setDimensions addListener addMenuIcon addToContextMenu? addToolTip changeBaseDocument colorByColumn colorByDefault downloadData downloadImage drawChart getChartData? getColorFunction getColorLegend getColorOptions getConfig getContextMenu getDiv getFilter getImage? getImageFromSVG getSettings hideToolTip onColumnRemoved onDataAdded onDataChanged onDataFiltered onDataHighlighted pinChart? remove removeFilter removeLayout? removeListener setColorLegend setFilter setSize setTitle showToolTip unpinChart? updateDeck

Constructors

constructor

Properties

__doc__

__doc__: Document

Optional_tooltip

_tooltip?: HTMLDivElement

billboard

billboard: boolean = true

canvas

canvas: HTMLCanvasElement

OptionalcolorBy

colorBy?: (index: number) => number[]

config

config: any

contentDiv

contentDiv: HTMLDivElement

contextMenu

contextMenu: ContextMenu

dataModel

dataModel: DataModel

dataStore

dataStore: DataStore

deck

deck: Deck<OrthographicView>

dialogs

dialogs: BaseDialog[] = []

div

div: HTMLElement

Optionalextra_legends

extra_legends?: any[]

height

height: number = 0

id

id: number

imageArray

imageArray: ImageArray

isPinned

isPinned: boolean = false

legend

legend: any

legendIcon

legendIcon: HTMLElement

listeners

listeners: Record<string, Listener>

menuSpace

menuSpace: HTMLDivElement

observable

observable: { container: HTMLElement }

opacity

opacity: number = 255

progress

progress: number = 0

resetButton

resetButton: HTMLSpanElement | HTMLButtonElement

saturation

saturation: number = 1

OptionalsettingsDialog

settingsDialog?: BaseDialog

size

size: number = 13

spaceX

spaceX: number = 600

spaceY

spaceY: number = 392

title

title: HTMLDivElement

titleBar

titleBar: HTMLDivElement

OptionalunpinIcon

unpinIcon?: HTMLElement

width

width: number = 0

Statictypes

types: ChartTypeMap

Accessors

dataSource

Methods

_addTrimmedColor

_addUnpinIcon

_callListeners

_getContentDimensions

_openSettingsDialog

_setConfigValue

_setDimensions

addListener

  • addListener(id: string, listener: Listener): void

  • Adds a listener to the datastore that will be called when an event occurs, passing the event type and any data. There are the following different types of event:-

    • removed - called when the chart has been removed

    Parameters

    • id: string

      a unique id indetifying the listener

    • listener: Listener

      a function that accepts two paramaters, the type of event and the data associated with it

    Returns void

addMenuIcon

  • addMenuIcon(
        icon: string,
        tooltip: string,
        config?: {
            func?: (e: MouseEvent) => void;
            position?: string;
            size?: string;
        },
    ): HTMLSpanElement

  • Adds a menu icon with tooltip to the title bar

    Parameters

    • icon: string

      the css classs of the icon (space delimited).

    • tooltip: string

      the tooltip text

    • config: { func?: (e: MouseEvent) => void; position?: string; size?: string } = {}

      extra inormation about the icon/tooltip

      • Optionalfunc?: (e: MouseEvent) => void

        a function that is called when the icon is clicked

      • Optionalposition?: string

        the position of the tooltip.

      • Optionalsize?: string

        the size of the tooltip

    Returns HTMLSpanElement

    • the icon

OptionaladdToContextMenu

addToolTip

changeBaseDocument

  • changeBaseDocument(doc: Document): void

  • Instructs the chart to use a different document. This is only required if you are going to add the chart to a different browser window

    Parameters

    • doc: Document

      the document that the chart will use

    Returns void

colorByColumn

colorByDefault

downloadData

downloadImage

drawChart

OptionalgetChartData

getColorFunction

  • getColorFunction(
        column: string,
        asArray?: boolean,
    ): (i: number) => [number, number, number]

  • Parameters

    • column: string
    • OptionalasArray: boolean

    Returns (i: number) => [number, number, number]

getColorLegend

getColorOptions

getConfig

getContextMenu

getDiv

getFilter

OptionalgetImage

getImageFromSVG

  • getImageFromSVG(
        svg: any,
        callback: (
            canvas: HTMLCanvasElement,
            ctx: CanvasRenderingContext2D,
        ) => void,
    ): void

  • Parameters

    • svg: any
    • callback: (canvas: HTMLCanvasElement, ctx: CanvasRenderingContext2D) => void

    Returns void

getSettings

  • getSettings(): GuiSpec<any>[]

  • Returns information about which controls to add to the settings dialog. Subclasses should call this method and then add their own controls e.g.

    getSettings(){
    let settings = super.getSettings();
    return settings.concat([{
      label:"A value"
      type:"slider",
      default_value:this.config.value,
      max:10,
      min:10,
      func:x=>{
          this.config.value=x;
          //update chart
      }
    }]);
}

    wrapping controls with a call to @{link g} will perform type checking todo- specifiy the link to g above properly/ document better

    Returns GuiSpec<any>[]

    an array of objects describing tweakable parameters

hideToolTip

onColumnRemoved

  • onColumnRemoved(column: string): boolean

  • Checks to see if the column is used in the chart If so, the chart will be removed but no callbacks will be involved

    Parameters

    • column: string

    Returns boolean

    true if the chart has been removed

onDataAdded

onDataChanged

onDataFiltered

onDataHighlighted

OptionalpinChart

remove

  • remove(notify?: boolean): void

  • Just removes the DOM elements, subclasses should do their own cleanup

    Parameters

    • Optionalnotify: boolean

    Returns void

removeFilter

OptionalremoveLayout

removeListener

setColorLegend

  • setColorLegend(): void

  • adds (or removes) the color legend depending on the chart's config color_legend.display value - assumes chart has a get colorLegend method

    Returns void

setFilter

setSize

  • setSize(x?: number, y?: number): void

  • Sets the size of the graph. If no parameters are supplied then the graph will be resized based on it container. Subclasses should overide this, but call the super method first which will calculate width and height of the content div

    Parameters

    • Optionalx: number

      The new width

    • Optionaly: number

      The new height;

    Returns void

setTitle

showToolTip

OptionalunpinChart

updateDeck

  • updateDeck(): ScatterplotLayer<
        {
            billboard: boolean;
            data: Int32Array<ArrayBuffer>;
            extensions: ImageArrayDeckExtension[];
            getFillColor: any;
            getImageAspect: (i: number) => undefined | number;
            getImageIndex: (i: number) => undefined | number;
            getPosition: (
                i: number,
                __namedParameters: AccessorContext<any>,
            ) => Float32Array;
            getRadius: 1;
            id: `scatter-${number}`;
            imageArray: ImageArray;
            opacity: number;
            pickable: true;
            radiusScale: number;
            saturation: number;
            updateTriggers: {
                getFillColor: (undefined | number | (index: number) => number[])[];
                getImageAspect: number;
                getPosition: number[];
            };
        },
    >[]

  • Returns ScatterplotLayer<
        {
            billboard: boolean;
            data: Int32Array<ArrayBuffer>;
            extensions: ImageArrayDeckExtension[];
            getFillColor: any;
            getImageAspect: (i: number) => undefined | number;
            getImageIndex: (i: number) => undefined | number;
            getPosition: (
                i: number,
                __namedParameters: AccessorContext<any>,
            ) => Float32Array;
            getRadius: 1;
            id: `scatter-${number}`;
            imageArray: ImageArray;
            opacity: number;
            pickable: true;
            radiusScale: number;
            saturation: number;
            updateTriggers: {
                getFillColor: (undefined | number | (index: number) => number[])[];
                getImageAspect: number;
                getPosition: number[];
            };
        },
    >[]

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods