Interface LegendRenderInfo

Information used for rendering the legend.

Hierarchy

Properties

addEntriesAutomatically? autoHideThreshold? backgroundEvents backgroundFillStyle? backgroundStrokeStyle? backgroundVisible? chartPadding chartTitleSpace entries entryMargin? marginInner? marginOuter orientation? padding? position renderOnTop? title? titleEvents titleFillStyle? titleFont? visible?

Properties

Optional addEntriesAutomatically

addEntriesAutomatically?: boolean

Whether legend entries should be automatically added and displayed.

Defaults to true for default legend and false for manually added legends (chart.addLegend).

Optional autoHideThreshold

autoHideThreshold?: number

The maximum allowed proportion of the viewport that the legend can occupy before it is automatically hidden. For example, a value of 0.75 means the legend will be hidden if it covers more than 75% of the viewport.

backgroundEvents

backgroundEvents: Eventer<LCJSInteractionEventMap, any>

Events for the legend background.

Optional backgroundFillStyle

backgroundFillStyle?: FillStyle

Background FillStyle of the legend.

Optional backgroundStrokeStyle

backgroundStrokeStyle?: LineStyle

Background LineStyle of the legend.

Optional backgroundVisible

backgroundVisible?: boolean

Whether the legend background should be visible.

chartPadding

chartPadding: Margin

Chart padding, used for adjusting the legend position.

chartTitleSpace

chartTitleSpace: Margin

Space allocated for the chart title, used for adjusting the legend position.

entries

entries: LegendEntry[]

Array of legend entries.

Optional entryMargin

entryMargin?: number

Margin between legend entries.

Optional marginInner

marginInner?: number

Margin from the main chart element to the legend.

marginOuter

marginOuter: Margin

Margin from the legend to the edge of the chart area.

Optional orientation

orientation?: LegendOrientation

Legend orientation. By default, this is automatically dictated by configured position But it can be forced to a specific value, which can be useful when positioning legends at arbitrary locations.

 // Example syntax, arbitrary location
 chart.legend.setOptions({
     position: {
         x: 0,
         y: 0,
         origin: UIOrigins.UIOrigins.LeftBottom
     },
     orientation: LegendOrientation.Horizontal
 })

Optional padding

padding?: Margin

Legend content padding.

position

position: LegendPosition | {
    origin?: Point;
    x: number;
    y: number;
}

Position of the legend. If x and y are provided, they will be interpreted as relative coordinates of the chart bottom left (chart.coordsRelative). If origin is provided, it will be interpreted as the origin of the legend position.

Optional renderOnTop

renderOnTop?: boolean

Whether the legend should be rendered on top of the chart.

Optional title

title?: string

Title of the legend.

titleEvents

titleEvents: Eventer<LCJSInteractionEventMap, any>

Events for the legend title.

Optional titleFillStyle

titleFillStyle?: FillStyle

FillStyle of the legend title.

Optional titleFont

titleFont?: Partial<FontSettings>

FontSettings of the legend title.

Optional visible

visible?: boolean

Whether the legend should be visible.

Settings

Member Visibility

Theme