Highcharts Dashboards
    Preparing search index...

    Interface Options

    interface Options {
        allowConnectorUpdate?: boolean;
        caption?: TextOptionsType;
        chartClassName?: string;
        chartConstructor?: ConstructorType;
        chartID?: string;
        chartOptions?: Partial<Options>;
        className?: string;
        connector?: ConnectorOptions | ConnectorOptions[];
        editableOptions?: Options[];
        events?: Record<string, Function>;
        id?: string;
        renderTo?: string;
        states?: StatesOptions;
        sync?: SyncOptions;
        syncHandlers?: OptionsRecord;
        title?: TextOptionsType;
        type: "Highcharts";
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowConnectorUpdate? caption? chartClassName? chartConstructor? chartID? chartOptions? className? connector? editableOptions? events? id? renderTo? states? sync? syncHandlers? title? type

    Properties

    allowConnectorUpdate?: boolean

    Whether to allow the component to edit the store to which it is attached.

    Try it:

    Allow connector update comparison

    true
    caption?: TextOptionsType

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

    Try it:

    Changed captions

    chartClassName?: string

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

    chartConstructor?: ConstructorType

    The string that declares constructor that is called for creating a chart.

    Example: chart, stockChart, mapChart or ganttChart.

    'chart'
    chartID?: string

    The id that is applied to the chart's container.

    chartOptions?: Partial<Options>

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

    className?: string

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

    connector?: ConnectorOptions | ConnectorOptions[]

    Connector options for the component.

    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

    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: "Highcharts"

    Type of the component.

    Settings

    On This Page

    Properties