Highcharts Dashboards
    Preparing search index...

    Interface Options

    Options to control the Grid component.

    interface Options {
        caption?: TextOptionsType;
        className?: string;
        connector?: ConnectorOptions;
        editableOptions?: Options[];
        events?: Record<string, Function>;
        gridClassName?: string;
        gridID?: string;
        gridOptions?: Options;
        id?: string;
        renderTo?: string;
        states?: StatesOptions;
        sync?: SyncOptions;
        syncHandlers?: OptionsRecord;
        title?: TextOptionsType;
        type: "Grid";
    }

    Hierarchy (View Summary)

    Index

    Properties

    caption? className? connector? editableOptions? events? gridClassName? gridID? gridOptions? id? renderTo? states? sync? syncHandlers? title? type

    Properties

    caption?: TextOptionsType

    The component's caption, which will render at the bottom.

    Try it:

    Changed captions

    className?: string

    The name of class that is applied to the component's container.

    connector?: ConnectorOptions

    Connector options

    editableOptions?: Options[]

    Set of options that are available for editing through sidebar.

    events?: Record<string, Function>

    Events attached to the component : mount, unmount, resize, update.

    Try it:

    Mount event

    gridClassName?: string

    The style class to add to the rendered data grid container.

    gridID?: string

    The identifier for the rendered data grid container.

    gridOptions?: Options

    Generic options to adjust behavior and styling of the rendered data grid.

    id?: string

    Sets an ID for the component's container.

    renderTo?: string

    Cell id, where component is attached.

    states?: StatesOptions

    States for the component.

    sync?: SyncOptions

    Defines which elements should be synced.

    Example:
    {
        highlight: true
    }

    Try it:

    Extremes Sync

    Highlight Sync

    Visibility Sync

    syncHandlers?: OptionsRecord

    Sync options for the component.

    title?: TextOptionsType

    The component's title, which will render at the top.

    Try it:

    Changed captions

    type: "Grid"

    The type of component like: HTML, KPI, Highcharts, Grid, Navigator.

    Settings

    On This Page

    Properties