Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxDataLegendComponent

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

Hierarchy

Hierarchy

  • IgxDataLegendComponent

Implements

  • AfterContentInit

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • renderer: Renderer2
    • _elRef: ViewContainerRef
    • ngZone: NgZone
    • injector: Injector
    • componentFactoryResolver: ComponentFactoryResolver

    Returns IgxDataLegendComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

container

container: Element

Static ngAcceptInputType_actualBadgesVisible

ngAcceptInputType_actualBadgesVisible: string | boolean

Static ngAcceptInputType_actualPixelScalingRatio

ngAcceptInputType_actualPixelScalingRatio: string | number

Static ngAcceptInputType_badgeMarginBottom

ngAcceptInputType_badgeMarginBottom: string | number

Static ngAcceptInputType_badgeMarginLeft

ngAcceptInputType_badgeMarginLeft: string | number

Static ngAcceptInputType_badgeMarginRight

ngAcceptInputType_badgeMarginRight: string | number

Static ngAcceptInputType_badgeMarginTop

ngAcceptInputType_badgeMarginTop: string | number

Static ngAcceptInputType_badgeShape

ngAcceptInputType_badgeShape: string | LegendItemBadgeShape

Static ngAcceptInputType_excludedColumns

ngAcceptInputType_excludedColumns: string | string[]

Static ngAcceptInputType_excludedSeries

ngAcceptInputType_excludedSeries: string | string[]

Static ngAcceptInputType_headerFormatDate

ngAcceptInputType_headerFormatDate: string | DataLegendHeaderDateMode

Static ngAcceptInputType_headerFormatSpecifiers

ngAcceptInputType_headerFormatSpecifiers: string | any[]

Static ngAcceptInputType_headerFormatTime

ngAcceptInputType_headerFormatTime: string | DataLegendHeaderTimeMode

Static ngAcceptInputType_headerRowMarginBottom

ngAcceptInputType_headerRowMarginBottom: string | number

Static ngAcceptInputType_headerRowMarginLeft

ngAcceptInputType_headerRowMarginLeft: string | number

Static ngAcceptInputType_headerRowMarginRight

ngAcceptInputType_headerRowMarginRight: string | number

Static ngAcceptInputType_headerRowMarginTop

ngAcceptInputType_headerRowMarginTop: string | number

Static ngAcceptInputType_headerRowVisible

ngAcceptInputType_headerRowVisible: string | boolean

Static ngAcceptInputType_headerTextMarginBottom

ngAcceptInputType_headerTextMarginBottom: string | number

Static ngAcceptInputType_headerTextMarginLeft

ngAcceptInputType_headerTextMarginLeft: string | number

Static ngAcceptInputType_headerTextMarginRight

ngAcceptInputType_headerTextMarginRight: string | number

Static ngAcceptInputType_headerTextMarginTop

ngAcceptInputType_headerTextMarginTop: string | number

Static ngAcceptInputType_includedColumns

ngAcceptInputType_includedColumns: string | string[]

Static ngAcceptInputType_includedSeries

ngAcceptInputType_includedSeries: string | string[]

Static ngAcceptInputType_labelDisplayMode

ngAcceptInputType_labelDisplayMode: string | DataLegendLabelMode

Static ngAcceptInputType_labelTextMarginBottom

ngAcceptInputType_labelTextMarginBottom: string | number

Static ngAcceptInputType_labelTextMarginLeft

ngAcceptInputType_labelTextMarginLeft: string | number

Static ngAcceptInputType_labelTextMarginRight

ngAcceptInputType_labelTextMarginRight: string | number

Static ngAcceptInputType_labelTextMarginTop

ngAcceptInputType_labelTextMarginTop: string | number

Static ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

Static ngAcceptInputType_shouldUpdateWhenSeriesDataChanges

ngAcceptInputType_shouldUpdateWhenSeriesDataChanges: string | boolean

Static ngAcceptInputType_summaryRowMarginBottom

ngAcceptInputType_summaryRowMarginBottom: string | number

Static ngAcceptInputType_summaryRowMarginLeft

ngAcceptInputType_summaryRowMarginLeft: string | number

Static ngAcceptInputType_summaryRowMarginRight

ngAcceptInputType_summaryRowMarginRight: string | number

Static ngAcceptInputType_summaryRowMarginTop

ngAcceptInputType_summaryRowMarginTop: string | number

Static ngAcceptInputType_summaryTitleTextMarginBottom

ngAcceptInputType_summaryTitleTextMarginBottom: string | number

Static ngAcceptInputType_summaryTitleTextMarginLeft

ngAcceptInputType_summaryTitleTextMarginLeft: string | number

Static ngAcceptInputType_summaryTitleTextMarginRight

ngAcceptInputType_summaryTitleTextMarginRight: string | number

Static ngAcceptInputType_summaryTitleTextMarginTop

ngAcceptInputType_summaryTitleTextMarginTop: string | number

Static ngAcceptInputType_summaryType

ngAcceptInputType_summaryType: string | DataLegendSummaryType

Static ngAcceptInputType_targetCursorPositionX

ngAcceptInputType_targetCursorPositionX: string | number

Static ngAcceptInputType_targetCursorPositionY

ngAcceptInputType_targetCursorPositionY: string | number

Static ngAcceptInputType_titleTextMarginBottom

ngAcceptInputType_titleTextMarginBottom: string | number

Static ngAcceptInputType_titleTextMarginLeft

ngAcceptInputType_titleTextMarginLeft: string | number

Static ngAcceptInputType_titleTextMarginRight

ngAcceptInputType_titleTextMarginRight: string | number

Static ngAcceptInputType_titleTextMarginTop

ngAcceptInputType_titleTextMarginTop: string | number

Static ngAcceptInputType_unitsDisplayMode

ngAcceptInputType_unitsDisplayMode: string | DataLegendUnitsMode

Static ngAcceptInputType_unitsTextMarginBottom

ngAcceptInputType_unitsTextMarginBottom: string | number

Static ngAcceptInputType_unitsTextMarginLeft

ngAcceptInputType_unitsTextMarginLeft: string | number

Static ngAcceptInputType_unitsTextMarginRight

ngAcceptInputType_unitsTextMarginRight: string | number

Static ngAcceptInputType_unitsTextMarginTop

ngAcceptInputType_unitsTextMarginTop: string | number

Static ngAcceptInputType_valueFormatAbbreviation

ngAcceptInputType_valueFormatAbbreviation: string | DataAbbreviationMode

Static ngAcceptInputType_valueFormatMaxFractions

ngAcceptInputType_valueFormatMaxFractions: string | number

Static ngAcceptInputType_valueFormatMinFractions

ngAcceptInputType_valueFormatMinFractions: string | number

Static ngAcceptInputType_valueFormatMode

ngAcceptInputType_valueFormatMode: string | DataLegendValueMode

Static ngAcceptInputType_valueFormatSpecifiers

ngAcceptInputType_valueFormatSpecifiers: string | any[]

Static ngAcceptInputType_valueFormatUseGrouping

ngAcceptInputType_valueFormatUseGrouping: string | boolean

Static ngAcceptInputType_valueRowMarginBottom

ngAcceptInputType_valueRowMarginBottom: string | number

Static ngAcceptInputType_valueRowMarginLeft

ngAcceptInputType_valueRowMarginLeft: string | number

Static ngAcceptInputType_valueRowMarginRight

ngAcceptInputType_valueRowMarginRight: string | number

Static ngAcceptInputType_valueRowMarginTop

ngAcceptInputType_valueRowMarginTop: string | number

Static ngAcceptInputType_valueRowVisible

ngAcceptInputType_valueRowVisible: string | boolean

Static ngAcceptInputType_valueTextMarginBottom

ngAcceptInputType_valueTextMarginBottom: string | number

Static ngAcceptInputType_valueTextMarginLeft

ngAcceptInputType_valueTextMarginLeft: string | number

Static ngAcceptInputType_valueTextMarginRight

ngAcceptInputType_valueTextMarginRight: string | number

Static ngAcceptInputType_valueTextMarginTop

ngAcceptInputType_valueTextMarginTop: string | number

Static ngAcceptInputType_valueTextUseSeriesColors

ngAcceptInputType_valueTextUseSeriesColors: string | boolean

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

actualBadgesVisible

  • get actualBadgesVisible(): boolean

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

    Returns boolean

  • set actualBadgesVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number

  • 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.

    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

calculateColumnSummary

  • get calculateColumnSummary(): EventEmitter<{
        args: IgxDataLegendSummaryEventArgs;
        sender: any;
    }>

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

    Returns EventEmitter<{
        args: IgxDataLegendSummaryEventArgs;
        sender: any;
    }>

excludedColumns

  • get excludedColumns(): string[]

  • 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 precedences over values of IncludedColumns property

    Returns string[]

  • set excludedColumns(v: string[]): void

  • Parameters

    • v: string[]

    Returns void

excludedSeries

  • get excludedSeries(): string[]

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

    Returns string[]

  • set excludedSeries(v: string[]): void

  • Parameters

    • v: string[]

    Returns void

headerFormatCulture

  • get headerFormatCulture(): string

  • 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

    Returns string

  • set headerFormatCulture(v: string): void

  • Parameters

    • v: string

    Returns void

headerFormatDate

  • get headerFormatDate(): DataLegendHeaderDateMode

  • 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

    Returns DataLegendHeaderDateMode

  • set headerFormatDate(v: DataLegendHeaderDateMode): void

  • Parameters

    Returns void

headerFormatSpecifiers

  • get headerFormatSpecifiers(): any[]

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

    Returns any[]

  • set headerFormatSpecifiers(v: any[]): void

  • Parameters

    • v: any[]

    Returns void

headerFormatString

  • get headerFormatString(): string

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

    Returns string

  • set headerFormatString(v: string): void

  • Parameters

    • v: string

    Returns void

headerFormatTime

  • get headerFormatTime(): DataLegendHeaderTimeMode

  • 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

    Returns DataLegendHeaderTimeMode

  • set headerFormatTime(v: DataLegendHeaderTimeMode): void

  • Parameters

    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

  • get headerRowVisible(): boolean

  • Gets or sets whether to show Header row.

    Returns boolean

  • set headerRowVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

headerText

  • get headerText(): string

  • Gets or sets the HeaderText for the data legend.

    Returns string

  • set headerText(v: string): void

  • Parameters

    • v: string

    Returns void

headerTextColor

  • get headerTextColor(): string

  • Gets or sets the header text color.

    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

  • get headerTextStyle(): string

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

    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

  • get includedColumns(): string[]

  • 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 precedences over values of IncludedColumns property

    Returns string[]

  • set includedColumns(v: string[]): void

  • Parameters

    • v: string[]

    Returns void

includedSeries

  • get includedSeries(): string[]

  • Gets or sets indexes or names of series to include in displaying in the data legend, e.g. "0, 1"

    Returns string[]

  • set includedSeries(v: string[]): void

  • Parameters

    • v: string[]

    Returns void

labelDisplayMode

  • get labelDisplayMode(): DataLegendLabelMode

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

    Returns DataLegendLabelMode

  • set labelDisplayMode(v: DataLegendLabelMode): void

  • Parameters

    Returns void

labelTextColor

  • get labelTextColor(): string

  • Gets or sets the units text color.

    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

  • get labelTextStyle(): string

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

    Returns string

  • set labelTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number

  • 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.

    Returns number

  • set pixelScalingRatio(v: number): void

  • Parameters

    • v: number

    Returns void

shouldUpdateWhenSeriesDataChanges

  • get shouldUpdateWhenSeriesDataChanges(): boolean

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

    Returns boolean

  • set shouldUpdateWhenSeriesDataChanges(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

styleHeaderRow

styleSeriesColumn

  • get styleSeriesColumn(): EventEmitter<{
        args: IgxDataLegendStylingColumnEventArgs;
        sender: any;
    }>

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

    Returns EventEmitter<{
        args: IgxDataLegendStylingColumnEventArgs;
        sender: any;
    }>

styleSeriesRow

  • get styleSeriesRow(): EventEmitter<{
        args: IgxDataLegendStylingRowEventArgs;
        sender: any;
    }>

  • Event raised when styling title and badge in series rows

    Returns EventEmitter<{
        args: IgxDataLegendStylingRowEventArgs;
        sender: any;
    }>

styleSummaryColumn

  • get styleSummaryColumn(): EventEmitter<{
        args: IgxDataLegendStylingColumnEventArgs;
        sender: any;
    }>

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

    Returns EventEmitter<{
        args: IgxDataLegendStylingColumnEventArgs;
        sender: any;
    }>

styleSummaryRow

  • get styleSummaryRow(): EventEmitter<{
        args: IgxDataLegendStylingRowEventArgs;
        sender: any;
    }>

  • Event raised when styling title in the summary row

    Returns EventEmitter<{
        args: IgxDataLegendStylingRowEventArgs;
        sender: any;
    }>

summaryLabelText

  • get summaryLabelText(): string

  • Gets or sets the units text for the data legend.

    Returns string

  • set summaryLabelText(v: string): void

  • Parameters

    • v: string

    Returns void

summaryLabelTextColor

  • get summaryLabelTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set summaryLabelTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

summaryLabelTextStyle

  • get summaryLabelTextStyle(): string

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

    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

  • get summaryTitleText(): string

  • Gets or sets the SummaryTitleText for the data legend.

    Returns string

  • set summaryTitleText(v: string): void

  • Parameters

    • v: string

    Returns void

summaryTitleTextColor

  • get summaryTitleTextColor(): string

  • Gets or sets the summary text color.

    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

  • get summaryTitleTextStyle(): string

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

    Returns string

  • set summaryTitleTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

summaryType

summaryUnitsText

  • get summaryUnitsText(): string

  • Gets or sets the units text for the data legend.

    Returns string

  • set summaryUnitsText(v: string): void

  • Parameters

    • v: string

    Returns void

summaryUnitsTextColor

  • get summaryUnitsTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set summaryUnitsTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

summaryUnitsTextStyle

  • get summaryUnitsTextStyle(): string

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

    Returns string

  • set summaryUnitsTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

summaryValueTextColor

  • get summaryValueTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set summaryValueTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

summaryValueTextStyle

  • get summaryValueTextStyle(): string

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

    Returns string

  • set summaryValueTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

target

  • get target(): any

  • Gets or sets the target for the data legend.

    Returns any

  • set target(v: any): void

  • Parameters

    • v: any

    Returns void

targetCursorPositionX

  • get targetCursorPositionX(): number

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

    Returns number

  • set targetCursorPositionX(v: number): void

  • Parameters

    • v: number

    Returns void

targetCursorPositionY

  • get targetCursorPositionY(): number

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

    Returns number

  • set targetCursorPositionY(v: number): void

  • Parameters

    • v: number

    Returns void

titleTextColor

  • get titleTextColor(): string

  • Gets or sets the display text color.

    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

  • get titleTextStyle(): string

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

    Returns string

  • set titleTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

unitsDisplayMode

unitsText

  • get unitsText(): string

  • Gets or sets the units text for the data legend.

    Returns string

  • set unitsText(v: string): void

  • Parameters

    • v: string

    Returns void

unitsTextColor

  • get unitsTextColor(): string

  • Gets or sets the units text color.

    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

  • get unitsTextStyle(): string

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

    Returns string

  • set unitsTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

valueFormatAbbreviation

  • get valueFormatAbbreviation(): DataAbbreviationMode

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

    Returns DataAbbreviationMode

  • set valueFormatAbbreviation(v: DataAbbreviationMode): void

  • Parameters

    Returns void

valueFormatCulture

  • get valueFormatCulture(): string

  • 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

    Returns string

  • set valueFormatCulture(v: string): void

  • Parameters

    • v: string

    Returns void

valueFormatCurrencyCode

  • get valueFormatCurrencyCode(): string

  • 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

    Returns string

  • set valueFormatCurrencyCode(v: string): void

  • Parameters

    • v: string

    Returns void

valueFormatMaxFractions

  • get valueFormatMaxFractions(): number

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

    Returns number

  • set valueFormatMaxFractions(v: number): void

  • Parameters

    • v: number

    Returns void

valueFormatMinFractions

  • get valueFormatMinFractions(): number

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

    Returns number

  • set valueFormatMinFractions(v: number): void

  • Parameters

    • v: number

    Returns void

valueFormatMode

  • get valueFormatMode(): DataLegendValueMode

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

    Returns DataLegendValueMode

  • set valueFormatMode(v: DataLegendValueMode): void

  • Parameters

    Returns void

valueFormatSpecifiers

  • get valueFormatSpecifiers(): any[]

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

    Returns any[]

  • set valueFormatSpecifiers(v: any[]): void

  • Parameters

    • v: any[]

    Returns void

valueFormatString

  • get valueFormatString(): string

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

    Returns string

  • set valueFormatString(v: string): void

  • Parameters

    • v: string

    Returns void

valueFormatUseGrouping

  • get valueFormatUseGrouping(): boolean

  • 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

    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

  • get valueRowVisible(): boolean

  • Gets or sets whether to show series rows.

    Returns boolean

  • set valueRowVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

valueTextColor

  • get valueTextColor(): string

  • Gets or sets the units text color.

    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

  • get valueTextStyle(): string

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

    Returns string

  • set valueTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

valueTextUseSeriesColors

  • get valueTextUseSeriesColors(): boolean

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

    Returns boolean

  • set valueTextUseSeriesColors(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

valueTextWhenMissingData

  • get valueTextWhenMissingData(): string

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

    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

ensureBadgeMargin

  • Returns void

ensureHeaderRowMargin

  • Returns void

ensureHeaderTextMargin

  • Returns void

ensureLabelTextMargin

  • Returns void

ensureSummaryRowMargin

  • Returns void

ensureSummaryTitleTextMargin

  • Returns void

ensureTitleTextMargin

  • Returns void

ensureUnitsTextMargin

  • Returns void

ensureValueRowMargin

  • Returns void

ensureValueTextMargin

  • Returns void

exportSerializedVisualData

  • Returns the legend visuals expressed as a serialized string.

    Returns string

findByName

  • Parameters

    • name: string

    Returns any

flush

  • Forces any pending refresh to the legend to be finished.

    Returns void

getAbbreviatedNumber

  • Parameters

    Returns number

getAbbreviatedString

  • Parameters

    Returns string

getAbbreviatedSymbol

  • Parameters

    Returns string

ngAfterContentInit

  • Returns void

ngOnDestroy

  • Returns void

notifySizeChanged

  • Notifies the legend about changes to size

    Returns void

updateStyle

  • Returns void