Class for all legend implementations.

Hierarchy

  • Legend

Implements

Properties

background: Eventer<LCJSInteractionEventMap, any> = ...

Interface for attaching listeners to user interaction events (click, pointerenter, etc.) on legend background.

 // Example syntax
chart.legend.background.addEventListener('click', (event) => {
console.log(event)
})

For syntax examples, refer to EventInterface. Available event keys are listed under LCJSInteractionEventMap

title: Eventer<LCJSInteractionEventMap, any> = ...

Interface for attaching listeners to user interaction events (click, pointerenter, etc.) on legend title.

 // Example syntax
chart.legend.title.addEventListener('click', (event) => {
console.log(event)
})

For syntax examples, refer to EventInterface. Available event keys are listed under LCJSInteractionEventMap

Methods

  • Remove all existing entries from the legend.

    Returns

    Object itself.

    Returns Legend

  • Get the current entries of the legend.

    Returns

    LegendEntry array.

    Returns LegendEntry[]

  • Remove existing entry from the legend.

    Returns

    Object itself.

    Parameters

    Returns Legend