Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SciChartLegend

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

The SciChartLegend displays a legend on the chart at top,left,bottom,right location and with customisable legend rows

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected backgroundColorProperty

backgroundColorProperty: string

Protected div

div: HTMLDivElement

Protected eventListenersCollection

eventListenersCollection: Map<string, IEventSubscriptionItem[]> = new Map<string,IEventSubscriptionItem[]>()

Protected invalidateParentSurface

invalidateParentSurface: () => void

Type declaration

    • (): void

    • Returns void

Protected isDirty

isDirty: boolean = true

legendItemCheckedChangedCallback

legendItemCheckedChangedCallback: (series: IRenderableSeries, isChecked: boolean) => void

Checked changed callback - when a legend item row checkbox is checked or unchecked. Set by parent LegendModifier

Type declaration

Protected marginProperty

marginProperty: number = 10

Protected orientationProperty

orientationProperty: ELegendOrientation = ELegendOrientation.Vertical

Protected parentDiv

parentDiv: HTMLDivElement

Protected parentSurfaceProperty

parentSurfaceProperty: ISciChartSurfaceBase

Protected placementDivIdProperty

placementDivIdProperty: string | HTMLDivElement

Protected placementProperty

placementProperty: ELegendPlacement = ELegendPlacement.TopLeft

Protected rootDiv

rootDiv: HTMLDivElement

Protected showLegendProperty

showLegendProperty: boolean = true

Protected textColorProperty

textColorProperty: string

Readonly type

type: SciChartLegend = ELegendType.SciChartLegend

Accessors

backgroundColor

  • get backgroundColor(): string
  • set backgroundColor(value: string): void

  • Gets or sets the backgroundColor as an html color code

    Returns string

  • Gets or sets the backgroundColor as an html color code

    Parameters

    • value: string

    Returns void

margin

  • get margin(): number
  • set margin(value: number): void

  • Gets or sets the margin in pixels

    Returns number

  • Gets or sets the margin in pixels

    Parameters

    • value: number

    Returns void

orientation

placement

placementDivId

  • get placementDivId(): string | HTMLDivElement
  • set placementDivId(value: string | HTMLDivElement): void

  • Gets or sets the parent div element reference or id for the Legend

    Returns string | HTMLDivElement

  • Gets or sets the parent div element reference or id for the Legend

    Parameters

    • value: string | HTMLDivElement

    Returns void

showCheckboxes

  • get showCheckboxes(): boolean
  • set showCheckboxes(value: boolean): void

  • Gets or sets whether series visibility checkboxes should be shown

    Returns boolean

  • Gets or sets whether series visibility checkboxes should be shown

    Parameters

    • value: boolean

    Returns void

showLegend

  • get showLegend(): boolean
  • set showLegend(value: boolean): void

  • When true, the legend is shown, else it is hidden

    Returns boolean

  • When true, the legend is shown, else it is hidden

    Parameters

    • value: boolean

    Returns void

showSeriesMarkers

  • get showSeriesMarkers(): boolean
  • set showSeriesMarkers(value: boolean): void

  • Gets or sets whether series markers should be shown

    Returns boolean

  • Gets or sets whether series markers should be shown

    Parameters

    • value: boolean

    Returns void

textColor

  • get textColor(): string
  • set textColor(value: string): void

  • Gets or sets the textColor as an html color code

    Returns string

  • Gets or sets the textColor as an html color code

    Parameters

    • value: string

    Returns void

Methods

Protected addEventListenerToSeries

Protected addEventListeners

  • addEventListeners(): void

applyTheme

  • applyTheme(): void

attachTo

clear

  • clear(): void

  • Returns void

Protected create

  • create(): void

  • Creates the legend in the DOM

    Returns void

delete

  • delete(): void

  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

detach

  • detach(): void

Protected getInnerHTML

  • getInnerHTML(): string

getLegendHTML

getLegendItemHTML

Protected getParentDiv

  • getParentDiv(): HTMLDivElement

invalidateLegend

  • invalidateLegend(): void

  • Invalidate the legend, hinting a redraw is needed

    Returns void

isExternal

  • isExternal(): boolean

  • Gets if the Legend in placed externally

    Returns boolean

Protected notifyPropertyChanged

  • notifyPropertyChanged(): void

Protected removeEventListenerFromSeries

  • removeEventListenerFromSeries(renderableSeriesId: string): void

Protected removeEventListeners

  • removeEventListeners(): void

setInvalidateParentSurface

  • setInvalidateParentSurface(value: () => void): void

setParentSurface

setRenderableSeriesArray

  • Sets the array of RenderableSeries to display in the legend

    remarks

    see SciChartSurface.renderableSeries which is the source for this array

    Parameters

    Returns void

setRootDiv

  • setRootDiv(rootDivProperty: HTMLDivElement): void

  • Set the root div in HTML where the legend will be placed

    Parameters

    • rootDivProperty: HTMLDivElement

    Returns void

setSeriesViewRect

  • setSeriesViewRect(seriesViewRect: Rect): void

update

  • update(): void

  • Update the legend

    Returns void

Generated using TypeDoc