Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dashboard

Index

Properties

createChart3D

createChart3D: function

createChartXY

createChartXY: function
    • Type parameters

      Parameters

      • options: ChartOptions<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerXBackgroundType, CursorTickMarkerYBackgroundType>

      Returns ChartXY<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerXBackgroundType, CursorTickMarkerYBackgroundType>

createFunnelChart

createFunnelChart: function

createGaugeChart

createGaugeChart: function
    • Type parameters

      Parameters

      Returns InstanceType<GaugeChartType>

createLegendBoxPanel

createLegendBoxPanel: function

createPieChart

createPieChart: function
    • Type parameters

      Parameters

      Returns InstanceType<PieChartType>

createPyramidChart

createPyramidChart: function

createSpiderChart

createSpiderChart: function
    • Type parameters

      Parameters

      • options: SpiderOptions<CursorPointMarkerType, CursorResultTableBackgroundType>

      Returns SpiderChart<CursorPointMarkerType, CursorResultTableBackgroundType>

createUIPanel

createUIPanel: function

createZoomBandChart

createZoomBandChart: function

engine

engine: PublicEngine

Methods

addLegendBox

  • Type parameters

    • UiElementType: UIPart

    Parameters

    Returns UiElementType & UIElement

    Object that fulfills interfaces: UIElementType (typeparam) and UIElement

addUIElement

  • Type parameters

    • UiElementType: UIPart

    Parameters

    Returns UiElementType & UIElement

    Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

  • disableAnimations(): this
  • Returns this

    Dashboard itself for fluent interface.

dispose

  • dispose(): this
  • Returns this

    Object itself for fluent interface

forEachChart

  • forEachChart(clbk: function): void
  • Parameters

    • clbk: function
        • Parameters

          • chart: Chart

          Returns void

    Returns void

getBackgroundFillStyle

getBackgroundStrokeStyle

  • getBackgroundStrokeStyle(): LineStyle
  • Returns LineStyle

    LineStyle

getHeight

  • getHeight(): [number | undefined, number | undefined] | undefined
  • Returns [number | undefined, number | undefined] | undefined

    Vertical boundaries as a tuple [minSize, maxSize]

getSplitterStyle

  • getSplitterStyle(): LineStyle
  • Returns LineStyle

    LineStyle object

getSplitterStyleHighlight

  • getSplitterStyleHighlight(): LineStyle
  • Returns LineStyle

    LineStyle object

getTheme

  • getTheme(): Theme
  • Returns Theme

    Theme

getWidth

  • getWidth(): [number | undefined, number | undefined] | undefined
  • Returns [number | undefined, number | undefined] | undefined

    Horizontal boundaries as a tuple [minSize, maxSize]

mapCharts

  • mapCharts(clbk: function): T[]
  • Type parameters

    • T

    Parameters

    • clbk: function
        • Parameters

          • chart: Chart

          Returns T

    Returns T[]

saveToFile

  • saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this
  • Parameters

    • fileName: string
    • Optional type: undefined | string
    • Optional encoderOptions: undefined | number

    Returns this

setBackgroundFillStyle

setBackgroundStrokeStyle

  • setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this
  • Parameters

    Returns this

    Object itself

setColumnWidth

  • setColumnWidth(index: number, relativeWidth: number): this
  • Parameters

    • index: number
    • relativeWidth: number

    Returns this

setHeight

  • setHeight(boundary: number | [number | undefined, number | undefined] | undefined): this
  • Parameters

    • boundary: number | [number | undefined, number | undefined] | undefined

    Returns this

setRowHeight

  • setRowHeight(index: number, relativeHeight: number): this
  • Parameters

    • index: number
    • relativeHeight: number

    Returns this

setSplitterStyle

  • Parameters

    Returns this

    Chart itself

setSplitterStyleHighlight

  • setSplitterStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this
  • Parameters

    Returns this

    Chart itself

setWidth

  • setWidth(boundary: number | [number | undefined, number | undefined] | undefined): this
  • Parameters

    • boundary: number | [number | undefined, number | undefined] | undefined

    Returns this