Highcharts Dashboards
    Preparing search index...

    Class Board

    Class that represents a dashboard.

    const dashboard = Dashboards.board('container', {
         gui: {
             layouts: [{
                 id: 'layout-1',
                 rows: [{
                     cells: [{
                         id: 'dashboard-col-0'
                     }]
                 }]
             }]
         },
         components: [{
             renderTo: 'dashboard-col-0',
             type: 'Highcharts',
             chartOptions: {
                 series: [{
                     data: [1, 2, 3, 4]
                 }]
             }
         }]
    });
    Index

    Properties

    container dataCursor dataPool id index layouts mountedComponents options

    Methods

    destroy getComponentByCellId getComponentById getOptions reflow update board

    Properties

    container: HTMLElement

    The main container for the dashboard. Created inside the element specified by user when creating the dashboard.

    dataCursor: DataCursor

    The data cursor instance used for emitting events on the data.

    dataPool: DataPool

    The data pool instance with all the connectors.

    id: string

    The unique id of the dashboard, it is generated automatically.

    index: number

    Index of the board in the global boards array. Allows to access the specific one when having multiple dashboards.

    layouts: Layout[]

    An array of generated layouts.

    mountedComponents: MountedComponent[]

    An array of mounted components on the dashboard.

    options: Options

    The options for the dashboard.

    Methods

    • Destroy the whole dashboard, its layouts and elements.

      Returns void

    • Convert the current state of board's options into JSON. The function does not support converting functions or events into JSON object.

      Returns DeepPartial<Options>

      Dashboards options.

    • Reflow the dashboard. Hide the toolbars and context pointer. Reflow the layouts and its cells.

      Returns void

    • Update the dashboard with new options.

      Parameters

      • newOptions: DeepPartial<Options>

        The new options to apply to the dashboard.

      Returns void

    • Factory function for creating a new dashboard.

      Parameters

      • renderTo: string | HTMLElement

        The DOM element to render to, or its id.

      • options: Options

        The options for the dashboard.

      • Optionalasync: boolean

        Whether to initialize the dashboard asynchronously. When false or undefined, the function returns the dashboard instance.

      Returns Board

    • Factory function for creating a new dashboard.

      Parameters

      • renderTo: string | HTMLElement

        The DOM element to render to, or its id.

      • options: Options

        The options for the dashboard.

      • async: true

        Whether to initialize the dashboard asynchronously. When true, the function returns a promise that resolves with the dashboard instance.

      Returns Promise<Board>

    Settings

    On This Page

    Properties
    Methods