Highcharts Dashboards
    Preparing search index...

    Interface HighchartsHighlightSyncOptions

    Highcharts component highlight sync options.

    Example:

    {
        enabled: true,
        highlightPoint: true,
        showTooltip: false,
        showCrosshair: true
    }
    interface HighchartsHighlightSyncOptions {
        affectedSeriesId?: string | null;
        emitter?: boolean | EmitterFunction | null;
        enabled?: boolean;
        group?: string;
        handler?: boolean | Function | null;
        highlightPoint?: boolean;
        showCrosshair?: boolean;
        showTooltip?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    affectedSeriesId? emitter? enabled? group? handler? highlightPoint? showCrosshair? showTooltip?

    Properties

    affectedSeriesId?: string | null

    ID of the series that should be affected by the highlight. If not defined, the appropriate series will be found according to the column assignment. This option only makes sense with tooltip.shared: false.

    Try it:

    Affected Series ID Option

    null
    emitter?: boolean | EmitterFunction | null

    Responsible for communicating to the component group that the action has been triggered on the component.

    If true or undefined the default emitter will be used, if false or null it will be disabled

    enabled?: boolean

    Whether the sync should be enabled.

    false
    group?: string

    The group in which components sharing the same connector should be synced.

    If null or undefined the component will be synced with all components with the same connector.

    Try it:

    Sync groups for the same connector

    undefined
    handler?: boolean | Function | null

    Responsible for handling incoming action from the synced component group.

    If true or undefined the default handler will be used, if false or null it will be disabled

    highlightPoint?: boolean

    Whether the marker should be synced. When hovering over a point in other component in the same group, the 'hover' state is enabled at the corresponding point in this component.

    true
    showCrosshair?: boolean

    Whether the crosshair should be synced. When hovering over a point in other component in the same group, in this component the crosshair should be also shown.

    Works only for axes that have crosshair enabled.

    true
    showTooltip?: boolean

    Whether the tooltip should be synced. When hovering over a point in other component in the same group, in this component the tooltip should be also shown.

    true

    Settings

    On This Page

    Properties