Class Legend

Hierarchy

Legend

Index

Constructors

Properties

container legendContainingElt options uiElt

Methods

hideLegend showLegend updateContent

Constructors

constructor

new Legend(elementSelector: string, containerSize: Size, options?: LegendOptions): Legend
Creates new instance of Legend.
Parameters
- elementSelector: string
  
  Selector of HTML element where to create legend.
- containerSize: Size
  
  Legend containing element size.
- Optional options: LegendOptions
  
  Legend element display options.
Returns Legend
- Defined in projects/some-charts-lib/src/chart/legend/legend.ts:21

Properties

`Private` container

container: JQuery<HTMLElement>

`Private` legendContainingElt

legendContainingElt: undefined | JQuery<HTMLElement>

`Private` options

options: LegendOptions

`Private` `Readonly` uiElt

uiElt: JQuery<HTMLElement>

Methods

hideLegend

hideLegend(): void
Hides legend, if it is shown.

Returns void
- Defined in projects/some-charts-lib/src/chart/legend/legend.ts:52

showLegend

showLegend(): void
Shows legend, if it is hidden.

Returns void
- Defined in projects/some-charts-lib/src/chart/legend/legend.ts:45

updateContent

updateContent(legendItems: LegendItem[]): void
Updates legend's content.
Parameters
- legendItems: LegendItem[]
  
  items to be shown on legend.
Returns void
- Defined in projects/some-charts-lib/src/chart/legend/legend.ts:60

Generated using TypeDoc