Highcharts Dashboards
    Preparing search index...

    Class HighchartsComponent

    Class that represents a Highcharts component.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    captionElement? chart? chartConstructor chartContainer chartOptions connectorHandlers dimensions editableOptions id isActive? options seriesFromConnector syncHandlers? type defaultOptions predefinedSyncConfig

    Methods

    destroy getDataTable getEditableOptions getEditableOptionValue getOptionsOnDrop initConnectors onTableChanged resize resizeDynamicContent resizeTo setCaption setTitle update

    Constructors

    Properties

    captionElement?: HTMLElement

    The HTML element where the caption is.

    chart?: Chart

    Reference to the chart.

    chartConstructor: ConstructorType

    Type of constructor used for creating proper chart like: chart, stock, gantt or map.

    Try it:

    Map constructor

    Gantt constructor

    Chart and Stock constructors

    chartContainer: HTMLElement

    HTML element where the chart is created.

    chartOptions: Partial<ChartOptions>

    A full set of chart options used by the chart. Highcharts API

    Try it:

    Chart options

    connectorHandlers: ConnectorHandler[] = []

    The connector handlers for the component. They are used to handle the connector options and data tables.

    dimensions: { height: number | null; width: number | null }

    Size of the component (width and height).

    editableOptions: EditableOptions

    An array of options marked as editable by the UI.

    id: string

    Sets an ID for the component's div.

    isActive?: boolean

    Whether the component state is active.

    options: Options

    Highcharts component's options.

    seriesFromConnector: Record<string, ConnectorHandler> = {}

    An object of series IDs and their connector handlers.

    syncHandlers?: OptionsRecord

    The sync handlers for the component.

    type: keyof ComponentTypeRegistry
    defaultOptions: Partial<Options> & DeepPartial<Options> = ...

    Default options of the Highcharts component.

    predefinedSyncConfig: PredefinedSyncConfig = HighchartsSyncs

    Predefined sync config for Highcharts component.

    Methods

    • Destroys the highcharts component.

      Returns void

    • Returns the data table connected to the component by the connectorId and dataTableKey. If both args are undefined, the first data table is returned.

      Parameters

      • OptionalconnectorId: string

        The id of the connector.

      • OptionaldataTableKey: string

        The key of the data table within the connector.

      Returns DataTable | undefined

      The data table, or undefined if no matching handler is found.

    • Parameters

      • OptionalpropertyPath: string[]

      Returns string | number | boolean | undefined

    • Returns the component's options when it is dropped from the sidebar.

      Parameters

      • sidebar: SidebarPopup

        The sidebar popup.

      Returns Partial<Options>

    • Function fired when component's data source's data is changed.

      Returns void

    • Resize the component

      Parameters

      • Optionalwidth: string | number | null

        The width to set the component to. Can be pixels, a percentage string or null. Null will unset the style

      • Optionalheight: string | number | null

        The height to set the component to. Can be pixels, a percentage string or null. Null will unset the style.

      Returns this

    • It's a temporary alternative for the resize method. It sets the strict pixel height for the component so that the content can be distributed in the right way, without looping the resizers in the content and container.

      Parameters

      • Optionalwidth: string | number | null

        The width to set the component to.

      • Optionalheight: string | number | null

        The height to set the component to.

      Returns void

    • Adjusts size of component to parent's cell size when animation is done.

      Parameters

      • element: HTMLElement

        HTML element that is resized.

      Returns void

    • Handles updating via options.

      Parameters

      • options: Partial<Options>

        The options to apply.

      • shouldRerender: boolean = true

      Returns Promise<void>

    Settings

    On This Page

    Constructors
    Properties
    Methods