IgxDataLegendComponent

Represents data legend that displays information about each series including values and summaries.

Constructors

new IgxDataLegendComponent(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector): IgxDataLegendComponent

Returns IgxDataLegendComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

container

container: Element

ngAcceptInputType_actualBadgesVisible

ngAcceptInputType_actualBadgesVisible: string | boolean

ngAcceptInputType_actualBorderThicknessBottom

ngAcceptInputType_actualBorderThicknessBottom: string | number

ngAcceptInputType_actualBorderThicknessLeft

ngAcceptInputType_actualBorderThicknessLeft: string | number

ngAcceptInputType_actualBorderThicknessRight

ngAcceptInputType_actualBorderThicknessRight: string | number

ngAcceptInputType_actualBorderThicknessTop

ngAcceptInputType_actualBorderThicknessTop: string | number

ngAcceptInputType_actualPixelScalingRatio

ngAcceptInputType_actualPixelScalingRatio: string | number

ngAcceptInputType_badgeMarginBottom

ngAcceptInputType_badgeMarginBottom: string | number

ngAcceptInputType_badgeMarginLeft

ngAcceptInputType_badgeMarginLeft: string | number

ngAcceptInputType_badgeMarginRight

ngAcceptInputType_badgeMarginRight: string | number

ngAcceptInputType_badgeMarginTop

ngAcceptInputType_badgeMarginTop: string | number

ngAcceptInputType_badgeShape

ngAcceptInputType_badgeShape: any

ngAcceptInputType_contentBorderThickness

ngAcceptInputType_contentBorderThickness: string | number

ngAcceptInputType_excludedColumns

ngAcceptInputType_excludedColumns: string | string[]

ngAcceptInputType_excludedSeries

ngAcceptInputType_excludedSeries: string | string[]

ngAcceptInputType_groupRowMarginBottom

ngAcceptInputType_groupRowMarginBottom: string | number

ngAcceptInputType_groupRowMarginLeft

ngAcceptInputType_groupRowMarginLeft: string | number

ngAcceptInputType_groupRowMarginRight

ngAcceptInputType_groupRowMarginRight: string | number

ngAcceptInputType_groupRowMarginTop

ngAcceptInputType_groupRowMarginTop: string | number

ngAcceptInputType_groupRowVisible

ngAcceptInputType_groupRowVisible: string | boolean

ngAcceptInputType_groupTextMarginBottom

ngAcceptInputType_groupTextMarginBottom: string | number

ngAcceptInputType_groupTextMarginLeft

ngAcceptInputType_groupTextMarginLeft: string | number

ngAcceptInputType_groupTextMarginRight

ngAcceptInputType_groupTextMarginRight: string | number

ngAcceptInputType_groupTextMarginTop

ngAcceptInputType_groupTextMarginTop: string | number

ngAcceptInputType_headerFormatDate

ngAcceptInputType_headerFormatDate: any

ngAcceptInputType_headerFormatSpecifiers

ngAcceptInputType_headerFormatSpecifiers: string | any[]

ngAcceptInputType_headerFormatTime

ngAcceptInputType_headerFormatTime: any

ngAcceptInputType_headerRowMarginBottom

ngAcceptInputType_headerRowMarginBottom: string | number

ngAcceptInputType_headerRowMarginLeft

ngAcceptInputType_headerRowMarginLeft: string | number

ngAcceptInputType_headerRowMarginRight

ngAcceptInputType_headerRowMarginRight: string | number

ngAcceptInputType_headerRowMarginTop

ngAcceptInputType_headerRowMarginTop: string | number

ngAcceptInputType_headerRowVisible

ngAcceptInputType_headerRowVisible: string | boolean

ngAcceptInputType_headerTextMarginBottom

ngAcceptInputType_headerTextMarginBottom: string | number

ngAcceptInputType_headerTextMarginLeft

ngAcceptInputType_headerTextMarginLeft: string | number

ngAcceptInputType_headerTextMarginRight

ngAcceptInputType_headerTextMarginRight: string | number

ngAcceptInputType_headerTextMarginTop

ngAcceptInputType_headerTextMarginTop: string | number

ngAcceptInputType_includedColumns

ngAcceptInputType_includedColumns: string | string[]

ngAcceptInputType_includedSeries

ngAcceptInputType_includedSeries: string | string[]

ngAcceptInputType_isEmbeddedInDataTooltip

ngAcceptInputType_isEmbeddedInDataTooltip: string | boolean

ngAcceptInputType_labelDisplayMode

ngAcceptInputType_labelDisplayMode: any

ngAcceptInputType_labelTextMarginBottom

ngAcceptInputType_labelTextMarginBottom: string | number

ngAcceptInputType_labelTextMarginLeft

ngAcceptInputType_labelTextMarginLeft: string | number

ngAcceptInputType_labelTextMarginRight

ngAcceptInputType_labelTextMarginRight: string | number

ngAcceptInputType_labelTextMarginTop

ngAcceptInputType_labelTextMarginTop: string | number

ngAcceptInputType_layoutMode

ngAcceptInputType_layoutMode: any

ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

ngAcceptInputType_shouldUpdateWhenSeriesDataChanges

ngAcceptInputType_shouldUpdateWhenSeriesDataChanges: string | boolean

ngAcceptInputType_summaryRowMarginBottom

ngAcceptInputType_summaryRowMarginBottom: string | number

ngAcceptInputType_summaryRowMarginLeft

ngAcceptInputType_summaryRowMarginLeft: string | number

ngAcceptInputType_summaryRowMarginRight

ngAcceptInputType_summaryRowMarginRight: string | number

ngAcceptInputType_summaryRowMarginTop

ngAcceptInputType_summaryRowMarginTop: string | number

ngAcceptInputType_summaryTitleTextMarginBottom

ngAcceptInputType_summaryTitleTextMarginBottom: string | number

ngAcceptInputType_summaryTitleTextMarginLeft

ngAcceptInputType_summaryTitleTextMarginLeft: string | number

ngAcceptInputType_summaryTitleTextMarginRight

ngAcceptInputType_summaryTitleTextMarginRight: string | number

ngAcceptInputType_summaryTitleTextMarginTop

ngAcceptInputType_summaryTitleTextMarginTop: string | number

ngAcceptInputType_summaryType

ngAcceptInputType_summaryType: any

ngAcceptInputType_targetCursorPositionX

ngAcceptInputType_targetCursorPositionX: string | number

ngAcceptInputType_targetCursorPositionY

ngAcceptInputType_targetCursorPositionY: string | number

ngAcceptInputType_titleTextMarginBottom

ngAcceptInputType_titleTextMarginBottom: string | number

ngAcceptInputType_titleTextMarginLeft

ngAcceptInputType_titleTextMarginLeft: string | number

ngAcceptInputType_titleTextMarginRight

ngAcceptInputType_titleTextMarginRight: string | number

ngAcceptInputType_titleTextMarginTop

ngAcceptInputType_titleTextMarginTop: string | number

ngAcceptInputType_unitsDisplayMode

ngAcceptInputType_unitsDisplayMode: any

ngAcceptInputType_unitsTextMarginBottom

ngAcceptInputType_unitsTextMarginBottom: string | number

ngAcceptInputType_unitsTextMarginLeft

ngAcceptInputType_unitsTextMarginLeft: string | number

ngAcceptInputType_unitsTextMarginRight

ngAcceptInputType_unitsTextMarginRight: string | number

ngAcceptInputType_unitsTextMarginTop

ngAcceptInputType_unitsTextMarginTop: string | number

ngAcceptInputType_valueFormatAbbreviation

ngAcceptInputType_valueFormatAbbreviation: any

ngAcceptInputType_valueFormatMaxFractions

ngAcceptInputType_valueFormatMaxFractions: string | number

ngAcceptInputType_valueFormatMinFractions

ngAcceptInputType_valueFormatMinFractions: string | number

ngAcceptInputType_valueFormatMode

ngAcceptInputType_valueFormatMode: any

ngAcceptInputType_valueFormatSpecifiers

ngAcceptInputType_valueFormatSpecifiers: string | any[]

ngAcceptInputType_valueFormatUseGrouping

ngAcceptInputType_valueFormatUseGrouping: string | boolean

ngAcceptInputType_valueRowMarginBottom

ngAcceptInputType_valueRowMarginBottom: string | number

ngAcceptInputType_valueRowMarginLeft

ngAcceptInputType_valueRowMarginLeft: string | number

ngAcceptInputType_valueRowMarginRight

ngAcceptInputType_valueRowMarginRight: string | number

ngAcceptInputType_valueRowMarginTop

ngAcceptInputType_valueRowMarginTop: string | number

ngAcceptInputType_valueRowVisible

ngAcceptInputType_valueRowVisible: string | boolean

ngAcceptInputType_valueTextMarginBottom

ngAcceptInputType_valueTextMarginBottom: string | number

ngAcceptInputType_valueTextMarginLeft

ngAcceptInputType_valueTextMarginLeft: string | number

ngAcceptInputType_valueTextMarginRight

ngAcceptInputType_valueTextMarginRight: string | number

ngAcceptInputType_valueTextMarginTop

ngAcceptInputType_valueTextMarginTop: string | number

ngAcceptInputType_valueTextUseSeriesColors

ngAcceptInputType_valueTextUseSeriesColors: string | boolean

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxDataLegendComponent, "igx-data-legend", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxDataLegendComponent, never>

Accessors

actualBackground

Gets the effective background of the data legend.

get actualBackground(): string

Returns string

set actualBackground(v: string): void

Parameters

v: string

Returns void

actualBadgesVisible

Gets whether or not at least one badge is visible based on BadgesShape and setting of a row's IsVisble in StyleSeriesRow event

get actualBadgesVisible(): boolean

Returns boolean

set actualBadgesVisible(v: boolean): void

Parameters

v: boolean

Returns void

actualBorderBrush

Gets the effective border brush of the data legend.

get actualBorderBrush(): string

Returns string

set actualBorderBrush(v: string): void

Parameters

v: string

Returns void

actualBorderThicknessBottom

get actualBorderThicknessBottom(): number

Returns number

set actualBorderThicknessBottom(v: number): void

Parameters

v: number

Returns void

actualBorderThicknessLeft

get actualBorderThicknessLeft(): number

Returns number

set actualBorderThicknessLeft(v: number): void

Parameters

v: number

Returns void

actualBorderThicknessRight

get actualBorderThicknessRight(): number

Returns number

set actualBorderThicknessRight(v: number): void

Parameters

v: number

Returns void

actualBorderThicknessTop

get actualBorderThicknessTop(): number

Returns number

set actualBorderThicknessTop(v: number): void

Parameters

v: number

Returns void

actualPixelScalingRatio

Gets the actual pixel scaling ratio used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

get actualPixelScalingRatio(): number

Returns number

set actualPixelScalingRatio(v: number): void

Parameters

v: number

Returns void

badgeMarginBottom

get badgeMarginBottom(): number

Returns number

set badgeMarginBottom(v: number): void

Parameters

v: number

Returns void

badgeMarginLeft

get badgeMarginLeft(): number

Returns number

set badgeMarginLeft(v: number): void

Parameters

v: number

Returns void

badgeMarginRight

get badgeMarginRight(): number

Returns number

set badgeMarginRight(v: number): void

Parameters

v: number

Returns void

badgeMarginTop

get badgeMarginTop(): number

Returns number

set badgeMarginTop(v: number): void

Parameters

v: number

Returns void

badgeShape

Gets or sets the BadgeShape for the data legend.

get badgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape

set badgeShape(v: LegendItemBadgeShape): void

Parameters

v: LegendItemBadgeShape

Returns void

calculateColumnSummary

Event raised when calculating summary value for each column in data legend

get calculateColumnSummary(): EventEmitter<object>

Returns EventEmitter<object>

contentBackground

Gets or sets the background of the data legend.

get contentBackground(): string

Returns string

set contentBackground(v: string): void

Parameters

v: string

Returns void

contentBorderBrush

Gets or sets the border color of the data legend.

get contentBorderBrush(): string

Returns string

set contentBorderBrush(v: string): void

Parameters

v: string

Returns void

contentBorderThickness

Gets or sets the border thickness of the data legend.

get contentBorderThickness(): number

Returns number

set contentBorderThickness(v: number): void

Parameters

v: number

Returns void

excludedColumns

Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property

get excludedColumns(): string[]

Returns string[]

set excludedColumns(v: string[]): void

Parameters

v: string[]

Returns void

excludedSeries

Gets or sets indexes, titles, or names of series to exclude from displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property

get excludedSeries(): string[]

Returns string[]

set excludedSeries(v: string[]): void

Parameters

v: string[]

Returns void

groupRowMarginBottom

get groupRowMarginBottom(): number

Returns number

set groupRowMarginBottom(v: number): void

Parameters

v: number

Returns void

groupRowMarginLeft

get groupRowMarginLeft(): number

Returns number

set groupRowMarginLeft(v: number): void

Parameters

v: number

Returns void

groupRowMarginRight

get groupRowMarginRight(): number

Returns number

set groupRowMarginRight(v: number): void

Parameters

v: number

Returns void

groupRowMarginTop

get groupRowMarginTop(): number

Returns number

set groupRowMarginTop(v: number): void

Parameters

v: number

Returns void

groupRowVisible

Gets or sets whether to show Header row.

get groupRowVisible(): boolean

Returns boolean

set groupRowVisible(v: boolean): void

Parameters

v: boolean

Returns void

groupTextColor

Gets or sets the Group text color.

get groupTextColor(): string

Returns string

set groupTextColor(v: string): void

Parameters

v: string

Returns void

groupTextMarginBottom

get groupTextMarginBottom(): number

Returns number

set groupTextMarginBottom(v: number): void

Parameters

v: number

Returns void

groupTextMarginLeft

get groupTextMarginLeft(): number

Returns number

set groupTextMarginLeft(v: number): void

Parameters

v: number

Returns void

groupTextMarginRight

get groupTextMarginRight(): number

Returns number

set groupTextMarginRight(v: number): void

Parameters

v: number

Returns void

groupTextMarginTop

get groupTextMarginTop(): number

Returns number

set groupTextMarginTop(v: number): void

Parameters

v: number

Returns void

groupTextStyle

Gets or Sets the style to use for the Group text.

get groupTextStyle(): string

Returns string

set groupTextStyle(v: string): void

Parameters

v: string

Returns void

headerFormatCulture

Gets or sets globalization culture applied to header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

get headerFormatCulture(): string

Returns string

set headerFormatCulture(v: string): void

Parameters

v: string

Returns void

headerFormatDate

Gets or sets date format for the header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

get headerFormatDate(): DataLegendHeaderDateMode

Returns DataLegendHeaderDateMode

set headerFormatDate(v: DataLegendHeaderDateMode): void

Parameters

v: DataLegendHeaderDateMode

Returns void

headerFormatSpecifiers

Gets or sets the format specifiers to use with the HeaderFormatString string.

get headerFormatSpecifiers(): any[]

Returns any[]

set headerFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

headerFormatString

Gets or sets the format string for header text displayed in the data legend.

get headerFormatString(): string

Returns string

set headerFormatString(v: string): void

Parameters

v: string

Returns void

headerFormatTime

Gets or sets time format for the header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

get headerFormatTime(): DataLegendHeaderTimeMode

Returns DataLegendHeaderTimeMode

set headerFormatTime(v: DataLegendHeaderTimeMode): void

Parameters

v: DataLegendHeaderTimeMode

Returns void

headerRowMarginBottom

get headerRowMarginBottom(): number

Returns number

set headerRowMarginBottom(v: number): void

Parameters

v: number

Returns void

headerRowMarginLeft

get headerRowMarginLeft(): number

Returns number

set headerRowMarginLeft(v: number): void

Parameters

v: number

Returns void

headerRowMarginRight

get headerRowMarginRight(): number

Returns number

set headerRowMarginRight(v: number): void

Parameters

v: number

Returns void

headerRowMarginTop

get headerRowMarginTop(): number

Returns number

set headerRowMarginTop(v: number): void

Parameters

v: number

Returns void

headerRowVisible

Gets or sets whether to show Header row.

get headerRowVisible(): boolean

Returns boolean

set headerRowVisible(v: boolean): void

Parameters

v: boolean

Returns void

headerText

Gets or sets the HeaderText for the data legend.

get headerText(): string

Returns string

set headerText(v: string): void

Parameters

v: string

Returns void

headerTextColor

Gets or sets the header text color.

get headerTextColor(): string

Returns string

set headerTextColor(v: string): void

Parameters

v: string

Returns void

headerTextMarginBottom

get headerTextMarginBottom(): number

Returns number

set headerTextMarginBottom(v: number): void

Parameters

v: number

Returns void

headerTextMarginLeft

get headerTextMarginLeft(): number

Returns number

set headerTextMarginLeft(v: number): void

Parameters

v: number

Returns void

headerTextMarginRight

get headerTextMarginRight(): number

Returns number

set headerTextMarginRight(v: number): void

Parameters

v: number

Returns void

headerTextMarginTop

get headerTextMarginTop(): number

Returns number

set headerTextMarginTop(v: number): void

Parameters

v: number

Returns void

headerTextStyle

Gets or Sets the style to use for the header text.

get headerTextStyle(): string

Returns string

set headerTextStyle(v: string): void

Parameters

v: string

Returns void

height

get height(): string

Returns string

set height(value: string): void

Parameters

value: string

Returns void

i

get i(): XamDataLegend

Returns XamDataLegend

includedColumns

Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property

get includedColumns(): string[]

Returns string[]

set includedColumns(v: string[]): void

Parameters

v: string[]

Returns void

includedSeries

Gets or sets indexes, titles, or names of series to include in displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property

get includedSeries(): string[]

Returns string[]

set includedSeries(v: string[]): void

Parameters

v: string[]

Returns void

isEmbeddedInDataTooltip

Gets or sets whether the legend is embedded in a DataTooltip

get isEmbeddedInDataTooltip(): boolean

Returns boolean

set isEmbeddedInDataTooltip(v: boolean): void

Parameters

v: boolean

Returns void

labelDisplayMode

Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series

get labelDisplayMode(): DataLegendLabelMode

Returns DataLegendLabelMode

set labelDisplayMode(v: DataLegendLabelMode): void

Parameters

v: DataLegendLabelMode

Returns void

labelTextColor

Gets or sets the units text color.

get labelTextColor(): string

Returns string

set labelTextColor(v: string): void

Parameters

v: string

Returns void

labelTextMarginBottom

get labelTextMarginBottom(): number

Returns number

set labelTextMarginBottom(v: number): void

Parameters

v: number

Returns void

labelTextMarginLeft

get labelTextMarginLeft(): number

Returns number

set labelTextMarginLeft(v: number): void

Parameters

v: number

Returns void

labelTextMarginRight

get labelTextMarginRight(): number

Returns number

set labelTextMarginRight(v: number): void

Parameters

v: number

Returns void

labelTextMarginTop

get labelTextMarginTop(): number

Returns number

set labelTextMarginTop(v: number): void

Parameters

v: number

Returns void

labelTextStyle

Gets or Sets the style to use for the units text.

get labelTextStyle(): string

Returns string

set labelTextStyle(v: string): void

Parameters

v: string

Returns void

layoutMode

Gets or sets the layout of content in the data legend

get layoutMode(): DataLegendLayoutMode

Returns DataLegendLayoutMode

set layoutMode(v: DataLegendLayoutMode): void

Parameters

v: DataLegendLayoutMode

Returns void

pixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

get pixelScalingRatio(): number

Returns number

set pixelScalingRatio(v: number): void

Parameters

v: number

Returns void

shouldUpdateWhenSeriesDataChanges

Gets or sets whether the data legend should update when the series data is mutated.

get shouldUpdateWhenSeriesDataChanges(): boolean

Returns boolean

set shouldUpdateWhenSeriesDataChanges(v: boolean): void

Parameters

v: boolean

Returns void

styleGroupRow

Event raised when styling the group row

get styleGroupRow(): EventEmitter<object>

Returns EventEmitter<object>

styleHeaderRow

Event raised when styling the header row

get styleHeaderRow(): EventEmitter<object>

Returns EventEmitter<object>

styleSeriesColumn

Event raised when styling the label, value, and unit columns in series rows

get styleSeriesColumn(): EventEmitter<object>

Returns EventEmitter<object>

styleSeriesRow

Event raised when styling title and badge in series rows

get styleSeriesRow(): EventEmitter<object>

Returns EventEmitter<object>

styleSummaryColumn

Event raised when styling the label, value, and unit columns in summary row

get styleSummaryColumn(): EventEmitter<object>

Returns EventEmitter<object>

styleSummaryRow

Event raised when styling title in the summary row

get styleSummaryRow(): EventEmitter<object>

Returns EventEmitter<object>

summaryLabelText

Gets or sets the units text for the data legend.

get summaryLabelText(): string

Returns string

set summaryLabelText(v: string): void

Parameters

v: string

Returns void

summaryLabelTextColor

Gets or sets the units text color.

get summaryLabelTextColor(): string

Returns string

set summaryLabelTextColor(v: string): void

Parameters

v: string

Returns void

summaryLabelTextStyle

Gets or Sets the style to use for the units text.

get summaryLabelTextStyle(): string

Returns string

set summaryLabelTextStyle(v: string): void

Parameters

v: string

Returns void

summaryRowMarginBottom

get summaryRowMarginBottom(): number

Returns number

set summaryRowMarginBottom(v: number): void

Parameters

v: number

Returns void

summaryRowMarginLeft

get summaryRowMarginLeft(): number

Returns number

set summaryRowMarginLeft(v: number): void

Parameters

v: number

Returns void

summaryRowMarginRight

get summaryRowMarginRight(): number

Returns number

set summaryRowMarginRight(v: number): void

Parameters

v: number

Returns void

summaryRowMarginTop

get summaryRowMarginTop(): number

Returns number

set summaryRowMarginTop(v: number): void

Parameters

v: number

Returns void

summaryTitleText

Gets or sets the SummaryTitleText for the data legend.

get summaryTitleText(): string

Returns string

set summaryTitleText(v: string): void

Parameters

v: string

Returns void

summaryTitleTextColor

Gets or sets the summary text color.

get summaryTitleTextColor(): string

Returns string

set summaryTitleTextColor(v: string): void

Parameters

v: string

Returns void

summaryTitleTextMarginBottom

get summaryTitleTextMarginBottom(): number

Returns number

set summaryTitleTextMarginBottom(v: number): void

Parameters

v: number

Returns void

summaryTitleTextMarginLeft

get summaryTitleTextMarginLeft(): number

Returns number

set summaryTitleTextMarginLeft(v: number): void

Parameters

v: number

Returns void

summaryTitleTextMarginRight

get summaryTitleTextMarginRight(): number

Returns number

set summaryTitleTextMarginRight(v: number): void

Parameters

v: number

Returns void

summaryTitleTextMarginTop

get summaryTitleTextMarginTop(): number

Returns number

set summaryTitleTextMarginTop(v: number): void

Parameters

v: number

Returns void

summaryTitleTextStyle

Gets or Sets the style to use for the summary text.

get summaryTitleTextStyle(): string

Returns string

set summaryTitleTextStyle(v: string): void

Parameters

v: string

Returns void

summaryType

Gets or sets the SummaryType for the data legend.

get summaryType(): DataLegendSummaryType

Returns DataLegendSummaryType

set summaryType(v: DataLegendSummaryType): void

Parameters

v: DataLegendSummaryType

Returns void

summaryUnitsText

Gets or sets the units text for the data legend.

get summaryUnitsText(): string

Returns string

set summaryUnitsText(v: string): void

Parameters

v: string

Returns void

summaryUnitsTextColor

Gets or sets the units text color.

get summaryUnitsTextColor(): string

Returns string

set summaryUnitsTextColor(v: string): void

Parameters

v: string

Returns void

summaryUnitsTextStyle

Gets or Sets the style to use for the units text.

get summaryUnitsTextStyle(): string

Returns string

set summaryUnitsTextStyle(v: string): void

Parameters

v: string

Returns void

summaryValueTextColor

Gets or sets the units text color.

get summaryValueTextColor(): string

Returns string

set summaryValueTextColor(v: string): void

Parameters

v: string

Returns void

summaryValueTextStyle

Gets or Sets the style to use for the units text.

get summaryValueTextStyle(): string

Returns string

set summaryValueTextStyle(v: string): void

Parameters

v: string

Returns void

target

Gets or sets the target for the data legend.

get target(): any

Returns any

set target(v: any): void

Parameters

v: any

Returns void

targetCursorPositionX

Gets or sets horizontal position (between 0.0 and 1.0) in viewport of the target component

get targetCursorPositionX(): number

Returns number

set targetCursorPositionX(v: number): void

Parameters

v: number

Returns void

targetCursorPositionY

Gets or sets vertical position (between 0.0 and 1.0) in viewport of the target component

get targetCursorPositionY(): number

Returns number

set targetCursorPositionY(v: number): void

Parameters

v: number

Returns void

titleTextColor

Gets or sets the display text color.

get titleTextColor(): string

Returns string

set titleTextColor(v: string): void

Parameters

v: string

Returns void

titleTextMarginBottom

get titleTextMarginBottom(): number

Returns number

set titleTextMarginBottom(v: number): void

Parameters

v: number

Returns void

titleTextMarginLeft

get titleTextMarginLeft(): number

Returns number

set titleTextMarginLeft(v: number): void

Parameters

v: number

Returns void

titleTextMarginRight

get titleTextMarginRight(): number

Returns number

set titleTextMarginRight(v: number): void

Parameters

v: number

Returns void

titleTextMarginTop

get titleTextMarginTop(): number

Returns number

set titleTextMarginTop(v: number): void

Parameters

v: number

Returns void

titleTextStyle

Gets or Sets the style to use for the display text.

get titleTextStyle(): string

Returns string

set titleTextStyle(v: string): void

Parameters

v: string

Returns void

unitsDisplayMode

Gets or sets the UnitsMode for the data legend.

get unitsDisplayMode(): DataLegendUnitsMode

Returns DataLegendUnitsMode

set unitsDisplayMode(v: DataLegendUnitsMode): void

Parameters

v: DataLegendUnitsMode

Returns void

unitsText

Gets or sets the units text for the data legend.

get unitsText(): string

Returns string

set unitsText(v: string): void

Parameters

v: string

Returns void

unitsTextColor

Gets or sets the units text color.

get unitsTextColor(): string

Returns string

set unitsTextColor(v: string): void

Parameters

v: string

Returns void

unitsTextMarginBottom

get unitsTextMarginBottom(): number

Returns number

set unitsTextMarginBottom(v: number): void

Parameters

v: number

Returns void

unitsTextMarginLeft

get unitsTextMarginLeft(): number

Returns number

set unitsTextMarginLeft(v: number): void

Parameters

v: number

Returns void

unitsTextMarginRight

get unitsTextMarginRight(): number

Returns number

set unitsTextMarginRight(v: number): void

Parameters

v: number

Returns void

unitsTextMarginTop

get unitsTextMarginTop(): number

Returns number

set unitsTextMarginTop(v: number): void

Parameters

v: number

Returns void

unitsTextStyle

Gets or Sets the style to use for the units text.

get unitsTextStyle(): string

Returns string

set unitsTextStyle(v: string): void

Parameters

v: string

Returns void

valueFormatAbbreviation

Gets or sets mode for abbreviating large numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatAbbreviation(): DataAbbreviationMode

Returns DataAbbreviationMode

set valueFormatAbbreviation(v: DataAbbreviationMode): void

Parameters

v: DataAbbreviationMode

Returns void

valueFormatCulture

Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatCulture(): string

Returns string

set valueFormatCulture(v: string): void

Parameters

v: string

Returns void

valueFormatCurrencyCode

Gets or sets the currency code used for displaying currency symbol next to values, e.g. USD for $, EUR for € This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatCurrencyCode(): string

Returns string

set valueFormatCurrencyCode(v: string): void

Parameters

v: string

Returns void

valueFormatMaxFractions

Gets or sets maximum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatMaxFractions(): number

Returns number

set valueFormatMaxFractions(v: number): void

Parameters

v: number

Returns void

valueFormatMinFractions

Gets or sets minimum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatMinFractions(): number

Returns number

set valueFormatMinFractions(v: number): void

Parameters

v: number

Returns void

valueFormatMode

Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)

get valueFormatMode(): DataLegendValueMode

Returns DataLegendValueMode

set valueFormatMode(v: DataLegendValueMode): void

Parameters

v: DataLegendValueMode

Returns void

valueFormatSpecifiers

Gets or sets the format specifiers to use with the ValueFormatString string.

get valueFormatSpecifiers(): any[]

Returns any[]

set valueFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

valueFormatString

Gets or sets the format string for values displayed in the data legend.

get valueFormatString(): string

Returns string

set valueFormatString(v: string): void

Parameters

v: string

Returns void

valueFormatUseGrouping

Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatUseGrouping(): boolean

Returns boolean

set valueFormatUseGrouping(v: boolean): void

Parameters

v: boolean

Returns void

valueRowMarginBottom

get valueRowMarginBottom(): number

Returns number

set valueRowMarginBottom(v: number): void

Parameters

v: number

Returns void

valueRowMarginLeft

get valueRowMarginLeft(): number

Returns number

set valueRowMarginLeft(v: number): void

Parameters

v: number

Returns void

valueRowMarginRight

get valueRowMarginRight(): number

Returns number

set valueRowMarginRight(v: number): void

Parameters

v: number

Returns void

valueRowMarginTop

get valueRowMarginTop(): number

Returns number

set valueRowMarginTop(v: number): void

Parameters

v: number

Returns void

valueRowVisible

Gets or sets whether to show series rows.

get valueRowVisible(): boolean

Returns boolean

set valueRowVisible(v: boolean): void

Parameters

v: boolean

Returns void

valueTextColor

Gets or sets the units text color.

get valueTextColor(): string

Returns string

set valueTextColor(v: string): void

Parameters

v: string

Returns void

valueTextMarginBottom

get valueTextMarginBottom(): number

Returns number

set valueTextMarginBottom(v: number): void

Parameters

v: number

Returns void

valueTextMarginLeft

get valueTextMarginLeft(): number

Returns number

set valueTextMarginLeft(v: number): void

Parameters

v: number

Returns void

valueTextMarginRight

get valueTextMarginRight(): number

Returns number

set valueTextMarginRight(v: number): void

Parameters

v: number

Returns void

valueTextMarginTop

get valueTextMarginTop(): number

Returns number

set valueTextMarginTop(v: number): void

Parameters

v: number

Returns void

valueTextStyle

Gets or Sets the style to use for the units text.

get valueTextStyle(): string

Returns string

set valueTextStyle(v: string): void

Parameters

v: string

Returns void

valueTextUseSeriesColors

Gets or sets whether to use series colors when displaying values in the legend

get valueTextUseSeriesColors(): boolean

Returns boolean

set valueTextUseSeriesColors(v: boolean): void

Parameters

v: boolean

Returns void

valueTextWhenMissingData

Gets or sets text displayed when data column is missing a value, e.g. "no data"

get valueTextWhenMissingData(): string

Returns string

set valueTextWhenMissingData(v: string): void

Parameters

v: string

Returns void

width

get width(): string

Returns string

set width(value: string): void

Parameters

value: string

Returns void

Methods

ensureActualBorderThickness

ensureActualBorderThickness(): void

Returns void

ensureBadgeMargin

ensureBadgeMargin(): void

Returns void

ensureGroupRowMargin

ensureGroupRowMargin(): void

Returns void

ensureGroupTextMargin

ensureGroupTextMargin(): void

Returns void

ensureHeaderRowMargin

ensureHeaderRowMargin(): void

Returns void

ensureHeaderTextMargin

ensureHeaderTextMargin(): void

Returns void

ensureLabelTextMargin

ensureLabelTextMargin(): void

Returns void

ensureSummaryRowMargin

ensureSummaryRowMargin(): void

Returns void

ensureSummaryTitleTextMargin

ensureSummaryTitleTextMargin(): void

Returns void

ensureTitleTextMargin

ensureTitleTextMargin(): void

Returns void

ensureUnitsTextMargin

ensureUnitsTextMargin(): void

Returns void

ensureValueRowMargin

ensureValueRowMargin(): void

Returns void

ensureValueTextMargin

ensureValueTextMargin(): void

Returns void

exportSerializedVisualData

Returns the legend visuals expressed as a serialized string.

exportSerializedVisualData(): string

Returns string

findByName

findByName(name: string): any

Parameters

name: string

Returns any

flush

Forces any pending refresh to the legend to be finished.

flush(): void

Returns void

getAbbreviatedNumber

getAbbreviatedNumber(number: number, mode: any, minDigits: number, maxDigits: number): number

Parameters

number: number
mode: any
minDigits: number
maxDigits: number

Returns number

getAbbreviatedString

getAbbreviatedString(number: number, mode: any, minDigits: number, maxDigits: number): string

Parameters

number: number
mode: any
minDigits: number
maxDigits: number

Returns string

getAbbreviatedSymbol

getAbbreviatedSymbol(number: number, mode: any, minDigits: number, maxDigits: number): string

Parameters

number: number
mode: any
minDigits: number
maxDigits: number

Returns string

ngAfterContentInit

ngAfterContentInit(): void

Returns void

ngOnDestroy

ngOnDestroy(): void

Returns void

notifySizeChanged

Notifies the legend about changes to size

notifySizeChanged(): void

Returns void

updateStyle

updateStyle(): void