Interface: LegendOptions

    Alignment of the legend.

    default ‘center’

    Defined in: index.esm.d.ts:2107 (opens new window)

    display

    • display: boolean

    Is the legend shown?

    default true

    Defined in: index.esm.d.ts:2097LegendOptions - 图2 (opens new window)

    fullSize

    • fullSize: boolean

    Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.

    default true

    Defined in: index.esm.d.ts:2112 (opens new window)

    Type declaration

    Defined in: index.esm.d.ts:2131LegendOptions - 图4 (opens new window)

    position

    • position: LayoutPosition

    Position of the legend.

    default ‘top’

    Defined in:

    reverse

    • reverse: boolean

    Legend will show datasets in reverse order.

    default false

    Defined in:

    • title: object

    Type declaration

    Defined in:

    Methods

    onClick

    A callback that is called when a click event is registered on a label item.

    Parameters

    Returns: void

    Defined in:

    onHover

    ▸ onHover(e: , legendItem: LegendItem, legend: ): void

    A callback that is called when a ‘mousemove’ event is registered on top of a label item

    Parameters

    Returns: void

    Defined in:

    ▸ onLeave(e: ChartEvent, legendItem: , legend: LegendElement): void

    A callback that is called when a ‘mousemove’ event is registered outside of a previously hovered label item.

    Parameters

    Returns: void

    Defined in: index.esm.d.ts:2129LegendOptions - 图10 (opens new window)