Class MultiLineChart

Hierarchy (View Summary)

Constructors

constructor

Properties

__doc__ _tooltip? config contentDiv contextMenu data dataStore defaultBandWidth dialogs dim div extra_legends? graph_area height isPinned legend legendIcon listeners margins menuSpace observable resetButton ry_axis_label ry_axis_svg settingsDialog? svg ticks title titleBar tx_axis_svg unpinIcon? width x_axis_call x_axis_label x_axis_svg x_scale y_axis_call y_axis_label y_axis_svg y_scale types

Accessors

dataSource

Methods

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

Constructors

constructor

Properties

__doc__

__doc__: Document

Optional_tooltip

_tooltip?: HTMLDivElement

config

config: any

contentDiv

contentDiv: HTMLDivElement

contextMenu

contextMenu: ContextMenu

data

data: any[]

dataStore

dataStore: DataStore

defaultBandWidth

defaultBandWidth: number

dialogs

dialogs: BaseDialog[] = []

dim

dim: Dimension

div

div: HTMLElement

Optionalextra_legends

extra_legends?: any[]

graph_area

graph_area: Selection<SVGGElement, any, null, undefined>

height

height: number = 0

isPinned

isPinned: boolean = false

legend

legend: any

legendIcon

legendIcon: HTMLElement

listeners

listeners: Record<string, Listener>

margins

margins: undefined | { bottom: any; left: any; right: any; top: any }

menuSpace

menuSpace: HTMLDivElement

observable

observable: { container: HTMLElement }

resetButton

resetButton: HTMLSpanElement | HTMLButtonElement

ry_axis_label

ry_axis_label: undefined | Selection<SVGTextElement, any, null, undefined>

ry_axis_svg

ry_axis_svg: Selection<SVGGElement, any, null, undefined>

OptionalsettingsDialog

settingsDialog?: BaseDialog

svg

svg: Selection<SVGSVGElement, any, null, undefined>

ticks

ticks: any

title

title: HTMLDivElement

titleBar

titleBar: HTMLDivElement

tx_axis_svg

tx_axis_svg: Selection<SVGGElement, any, null, undefined>

OptionalunpinIcon

unpinIcon?: HTMLElement

width

width: number = 0

x_axis_call

x_axis_call: undefined | Axis<string>

x_axis_label

x_axis_label: undefined | Selection<SVGTextElement, any, null, undefined>

x_axis_svg

x_axis_svg: Selection<SVGGElement, any, null, undefined>

x_scale

x_scale: undefined | ScaleBand<string> | ScaleLinear<number, number>

y_axis_call

y_axis_call: undefined | Axis<string>

y_axis_label

y_axis_label: undefined | Selection<SVGTextElement, any, null, undefined>

y_axis_svg

y_axis_svg: Selection<SVGGElement, any, null, undefined>

y_scale

y_scale: undefined | ScaleBand<string> | ScaleLinear<number, number>

Statictypes

types: ChartTypeMap

Accessors

dataSource

Methods

_addLegendToSVG

_addTrimmedColor

_addUnpinIcon

_callListeners

_getContentDimensions

_openSettingsDialog

_removeLegendFromSVG

_setConfigValue

_setDimensions

_setMargins

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

changeCategories

OptionalcolorByColumn

OptionalcolorByDefault

downloadData

downloadImage

drawChart

drawXTree

drawYTree

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

getImage

getImageFromSVG

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

  • Parameters

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

    Returns void

getSettings

  • getSettings(): AnyGuiSpec[]

  • 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 AnyGuiSpec[]

    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

  • onDataFiltered(dim: any): void

  • Called by the datastore when the data is filtered. Needs to be implemented on any subclasses.

    Parameters

    • dim: any

      the dimension that has been filtered

    Returns void

onDataHighlighted

OptionalpinChart

remove

removeFilter

OptionalremoveLayout

removeListener

scaleTrim

setAxisSize

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: any, y: any): 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

    • x: any

      The new width

    • y: any

      The new height;

    Returns void

setTitle

showToolTip

stackLines

unpinChart

updateAxis

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods