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

IgxDataLegendComponent

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

Returns IgxDataLegendComponent

_dynamicContent: ViewContainerRef
container: Element

ngAcceptInputType_actualBadgesVisible

Section titled "ngAcceptInputType_actualBadgesVisible"
ngAcceptInputType_actualBadgesVisible: string | boolean

ngAcceptInputType_actualBorderThicknessBottom

Section titled "ngAcceptInputType_actualBorderThicknessBottom"
ngAcceptInputType_actualBorderThicknessBottom: string | number

ngAcceptInputType_actualBorderThicknessLeft

Section titled "ngAcceptInputType_actualBorderThicknessLeft"
ngAcceptInputType_actualBorderThicknessLeft: string | number

ngAcceptInputType_actualBorderThicknessRight

Section titled "ngAcceptInputType_actualBorderThicknessRight"
ngAcceptInputType_actualBorderThicknessRight: string | number

ngAcceptInputType_actualBorderThicknessTop

Section titled "ngAcceptInputType_actualBorderThicknessTop"
ngAcceptInputType_actualBorderThicknessTop: string | number

ngAcceptInputType_actualPixelScalingRatio

Section titled "ngAcceptInputType_actualPixelScalingRatio"
ngAcceptInputType_actualPixelScalingRatio: string | number

ngAcceptInputType_badgeMarginBottom

Section titled "ngAcceptInputType_badgeMarginBottom"
ngAcceptInputType_badgeMarginBottom: string | number
ngAcceptInputType_badgeMarginLeft: string | number
ngAcceptInputType_badgeMarginRight: string | number
ngAcceptInputType_badgeMarginTop: string | number
ngAcceptInputType_badgeShape: any

ngAcceptInputType_contentBorderThickness

Section titled "ngAcceptInputType_contentBorderThickness"
ngAcceptInputType_contentBorderThickness: string | number
ngAcceptInputType_excludedColumns: string | string[]
ngAcceptInputType_excludedSeries: string | string[]

ngAcceptInputType_groupRowMarginBottom

Section titled "ngAcceptInputType_groupRowMarginBottom"
ngAcceptInputType_groupRowMarginBottom: string | number

ngAcceptInputType_groupRowMarginLeft

Section titled "ngAcceptInputType_groupRowMarginLeft"
ngAcceptInputType_groupRowMarginLeft: string | number

ngAcceptInputType_groupRowMarginRight

Section titled "ngAcceptInputType_groupRowMarginRight"
ngAcceptInputType_groupRowMarginRight: string | number

ngAcceptInputType_groupRowMarginTop

Section titled "ngAcceptInputType_groupRowMarginTop"
ngAcceptInputType_groupRowMarginTop: string | number
ngAcceptInputType_groupRowVisible: string | boolean

ngAcceptInputType_groupTextMarginBottom

Section titled "ngAcceptInputType_groupTextMarginBottom"
ngAcceptInputType_groupTextMarginBottom: string | number

ngAcceptInputType_groupTextMarginLeft

Section titled "ngAcceptInputType_groupTextMarginLeft"
ngAcceptInputType_groupTextMarginLeft: string | number

ngAcceptInputType_groupTextMarginRight

Section titled "ngAcceptInputType_groupTextMarginRight"
ngAcceptInputType_groupTextMarginRight: string | number

ngAcceptInputType_groupTextMarginTop

Section titled "ngAcceptInputType_groupTextMarginTop"
ngAcceptInputType_groupTextMarginTop: string | number
ngAcceptInputType_headerFormatDate: any

ngAcceptInputType_headerFormatSpecifiers

Section titled "ngAcceptInputType_headerFormatSpecifiers"
ngAcceptInputType_headerFormatSpecifiers: string | any[]
ngAcceptInputType_headerFormatTime: any

ngAcceptInputType_headerRowMarginBottom

Section titled "ngAcceptInputType_headerRowMarginBottom"
ngAcceptInputType_headerRowMarginBottom: string | number

ngAcceptInputType_headerRowMarginLeft

Section titled "ngAcceptInputType_headerRowMarginLeft"
ngAcceptInputType_headerRowMarginLeft: string | number

ngAcceptInputType_headerRowMarginRight

Section titled "ngAcceptInputType_headerRowMarginRight"
ngAcceptInputType_headerRowMarginRight: string | number

ngAcceptInputType_headerRowMarginTop

Section titled "ngAcceptInputType_headerRowMarginTop"
ngAcceptInputType_headerRowMarginTop: string | number
ngAcceptInputType_headerRowVisible: string | boolean

ngAcceptInputType_headerTextMarginBottom

Section titled "ngAcceptInputType_headerTextMarginBottom"
ngAcceptInputType_headerTextMarginBottom: string | number

ngAcceptInputType_headerTextMarginLeft

Section titled "ngAcceptInputType_headerTextMarginLeft"
ngAcceptInputType_headerTextMarginLeft: string | number

ngAcceptInputType_headerTextMarginRight

Section titled "ngAcceptInputType_headerTextMarginRight"
ngAcceptInputType_headerTextMarginRight: string | number

ngAcceptInputType_headerTextMarginTop

Section titled "ngAcceptInputType_headerTextMarginTop"
ngAcceptInputType_headerTextMarginTop: string | number
ngAcceptInputType_includedColumns: string | string[]
ngAcceptInputType_includedSeries: string | string[]

ngAcceptInputType_isEmbeddedInDataTooltip

Section titled "ngAcceptInputType_isEmbeddedInDataTooltip"
ngAcceptInputType_isEmbeddedInDataTooltip: string | boolean
ngAcceptInputType_labelDisplayMode: any

ngAcceptInputType_labelTextMarginBottom

Section titled "ngAcceptInputType_labelTextMarginBottom"
ngAcceptInputType_labelTextMarginBottom: string | number

ngAcceptInputType_labelTextMarginLeft

Section titled "ngAcceptInputType_labelTextMarginLeft"
ngAcceptInputType_labelTextMarginLeft: string | number

ngAcceptInputType_labelTextMarginRight

Section titled "ngAcceptInputType_labelTextMarginRight"
ngAcceptInputType_labelTextMarginRight: string | number

ngAcceptInputType_labelTextMarginTop

Section titled "ngAcceptInputType_labelTextMarginTop"
ngAcceptInputType_labelTextMarginTop: string | number
ngAcceptInputType_layoutMode: any

ngAcceptInputType_pixelScalingRatio

Section titled "ngAcceptInputType_pixelScalingRatio"
ngAcceptInputType_pixelScalingRatio: string | number

ngAcceptInputType_shouldUpdateWhenSeriesDataChanges

Section titled "ngAcceptInputType_shouldUpdateWhenSeriesDataChanges"
ngAcceptInputType_shouldUpdateWhenSeriesDataChanges: string | boolean

ngAcceptInputType_summaryRowMarginBottom

Section titled "ngAcceptInputType_summaryRowMarginBottom"
ngAcceptInputType_summaryRowMarginBottom: string | number

ngAcceptInputType_summaryRowMarginLeft

Section titled "ngAcceptInputType_summaryRowMarginLeft"
ngAcceptInputType_summaryRowMarginLeft: string | number

ngAcceptInputType_summaryRowMarginRight

Section titled "ngAcceptInputType_summaryRowMarginRight"
ngAcceptInputType_summaryRowMarginRight: string | number

ngAcceptInputType_summaryRowMarginTop

Section titled "ngAcceptInputType_summaryRowMarginTop"
ngAcceptInputType_summaryRowMarginTop: string | number

ngAcceptInputType_summaryTitleTextMarginBottom

Section titled "ngAcceptInputType_summaryTitleTextMarginBottom"
ngAcceptInputType_summaryTitleTextMarginBottom: string | number

ngAcceptInputType_summaryTitleTextMarginLeft

Section titled "ngAcceptInputType_summaryTitleTextMarginLeft"
ngAcceptInputType_summaryTitleTextMarginLeft: string | number

ngAcceptInputType_summaryTitleTextMarginRight

Section titled "ngAcceptInputType_summaryTitleTextMarginRight"
ngAcceptInputType_summaryTitleTextMarginRight: string | number

ngAcceptInputType_summaryTitleTextMarginTop

Section titled "ngAcceptInputType_summaryTitleTextMarginTop"
ngAcceptInputType_summaryTitleTextMarginTop: string | number
ngAcceptInputType_summaryType: any

ngAcceptInputType_targetCursorPositionX

Section titled "ngAcceptInputType_targetCursorPositionX"
ngAcceptInputType_targetCursorPositionX: string | number

ngAcceptInputType_targetCursorPositionY

Section titled "ngAcceptInputType_targetCursorPositionY"
ngAcceptInputType_targetCursorPositionY: string | number

ngAcceptInputType_titleTextMarginBottom

Section titled "ngAcceptInputType_titleTextMarginBottom"
ngAcceptInputType_titleTextMarginBottom: string | number

ngAcceptInputType_titleTextMarginLeft

Section titled "ngAcceptInputType_titleTextMarginLeft"
ngAcceptInputType_titleTextMarginLeft: string | number

ngAcceptInputType_titleTextMarginRight

Section titled "ngAcceptInputType_titleTextMarginRight"
ngAcceptInputType_titleTextMarginRight: string | number

ngAcceptInputType_titleTextMarginTop

Section titled "ngAcceptInputType_titleTextMarginTop"
ngAcceptInputType_titleTextMarginTop: string | number
ngAcceptInputType_unitsDisplayMode: any

ngAcceptInputType_unitsTextMarginBottom

Section titled "ngAcceptInputType_unitsTextMarginBottom"
ngAcceptInputType_unitsTextMarginBottom: string | number

ngAcceptInputType_unitsTextMarginLeft

Section titled "ngAcceptInputType_unitsTextMarginLeft"
ngAcceptInputType_unitsTextMarginLeft: string | number

ngAcceptInputType_unitsTextMarginRight

Section titled "ngAcceptInputType_unitsTextMarginRight"
ngAcceptInputType_unitsTextMarginRight: string | number

ngAcceptInputType_unitsTextMarginTop

Section titled "ngAcceptInputType_unitsTextMarginTop"
ngAcceptInputType_unitsTextMarginTop: string | number

ngAcceptInputType_valueFormatAbbreviation

Section titled "ngAcceptInputType_valueFormatAbbreviation"
ngAcceptInputType_valueFormatAbbreviation: any

ngAcceptInputType_valueFormatMaxFractions

Section titled "ngAcceptInputType_valueFormatMaxFractions"
ngAcceptInputType_valueFormatMaxFractions: string | number

ngAcceptInputType_valueFormatMinFractions

Section titled "ngAcceptInputType_valueFormatMinFractions"
ngAcceptInputType_valueFormatMinFractions: string | number
ngAcceptInputType_valueFormatMode: any

ngAcceptInputType_valueFormatSpecifiers

Section titled "ngAcceptInputType_valueFormatSpecifiers"
ngAcceptInputType_valueFormatSpecifiers: string | any[]

ngAcceptInputType_valueFormatUseGrouping

Section titled "ngAcceptInputType_valueFormatUseGrouping"
ngAcceptInputType_valueFormatUseGrouping: string | boolean

ngAcceptInputType_valueRowMarginBottom

Section titled "ngAcceptInputType_valueRowMarginBottom"
ngAcceptInputType_valueRowMarginBottom: string | number

ngAcceptInputType_valueRowMarginLeft

Section titled "ngAcceptInputType_valueRowMarginLeft"
ngAcceptInputType_valueRowMarginLeft: string | number

ngAcceptInputType_valueRowMarginRight

Section titled "ngAcceptInputType_valueRowMarginRight"
ngAcceptInputType_valueRowMarginRight: string | number

ngAcceptInputType_valueRowMarginTop

Section titled "ngAcceptInputType_valueRowMarginTop"
ngAcceptInputType_valueRowMarginTop: string | number
ngAcceptInputType_valueRowVisible: string | boolean

ngAcceptInputType_valueTextMarginBottom

Section titled "ngAcceptInputType_valueTextMarginBottom"
ngAcceptInputType_valueTextMarginBottom: string | number

ngAcceptInputType_valueTextMarginLeft

Section titled "ngAcceptInputType_valueTextMarginLeft"
ngAcceptInputType_valueTextMarginLeft: string | number

ngAcceptInputType_valueTextMarginRight

Section titled "ngAcceptInputType_valueTextMarginRight"
ngAcceptInputType_valueTextMarginRight: string | number

ngAcceptInputType_valueTextMarginTop

Section titled "ngAcceptInputType_valueTextMarginTop"
ngAcceptInputType_valueTextMarginTop: string | number

ngAcceptInputType_valueTextUseSeriesColors

Section titled "ngAcceptInputType_valueTextUseSeriesColors"
ngAcceptInputType_valueTextUseSeriesColors: string | boolean
ɵcmp: ɵɵComponentDeclaration<IgxDataLegendComponent, "igx-data-legend", never, object, object, never, never>
ɵfac: ɵɵFactoryDeclaration<IgxDataLegendComponent, never>
actualBackground: string
actualBadgesVisible: boolean
actualBorderBrush: string
actualBorderThicknessBottom: number
actualBorderThicknessLeft: number
actualBorderThicknessRight: number
actualBorderThicknessTop: number
actualPixelScalingRatio: number
badgeMarginBottom: number
badgeMarginLeft: number
badgeMarginRight: number
badgeMarginTop: number
badgeShape: LegendItemBadgeShape
contentBackground: string
contentBorderBrush: string
contentBorderThickness: number
excludedColumns: string[]
excludedSeries: string[]
groupRowMarginBottom: number
groupRowMarginLeft: number
groupRowMarginRight: number
groupRowMarginTop: number
groupRowVisible: boolean
groupTextColor: string
groupTextMarginBottom: number
groupTextMarginLeft: number
groupTextMarginRight: number
groupTextMarginTop: number
groupTextStyle: string
headerFormatCulture: string
headerFormatDate: DataLegendHeaderDateMode
headerFormatSpecifiers: any[]
headerFormatString: string
headerFormatTime: DataLegendHeaderTimeMode
headerRowMarginBottom: number
headerRowMarginLeft: number
headerRowMarginRight: number
headerRowMarginTop: number
headerRowVisible: boolean
headerText: string
headerTextColor: string
headerTextMarginBottom: number
headerTextMarginLeft: number
headerTextMarginRight: number
headerTextMarginTop: number
headerTextStyle: string
height: string
includedColumns: string[]
includedSeries: string[]
isEmbeddedInDataTooltip: boolean
labelDisplayMode: DataLegendLabelMode
labelTextColor: string
labelTextMarginBottom: number
labelTextMarginLeft: number
labelTextMarginRight: number
labelTextMarginTop: number
labelTextStyle: string
layoutMode: DataLegendLayoutMode
pixelScalingRatio: number
shouldUpdateWhenSeriesDataChanges: boolean
summaryLabelText: string
summaryLabelTextColor: string
summaryLabelTextStyle: string
summaryRowMarginBottom: number
summaryRowMarginLeft: number
summaryRowMarginRight: number
summaryRowMarginTop: number
summaryTitleText: string
summaryTitleTextColor: string
summaryTitleTextMarginBottom: number
summaryTitleTextMarginLeft: number
summaryTitleTextMarginRight: number
summaryTitleTextMarginTop: number
summaryTitleTextStyle: string
summaryType: DataLegendSummaryType
summaryUnitsText: string
summaryUnitsTextColor: string
summaryUnitsTextStyle: string
summaryValueTextColor: string
summaryValueTextStyle: string
target: any
targetCursorPositionX: number
targetCursorPositionY: number
titleTextColor: string
titleTextMarginBottom: number
titleTextMarginLeft: number
titleTextMarginRight: number
titleTextMarginTop: number
titleTextStyle: string
unitsDisplayMode: DataLegendUnitsMode
unitsText: string
unitsTextColor: string
unitsTextMarginBottom: number
unitsTextMarginLeft: number
unitsTextMarginRight: number
unitsTextMarginTop: number
unitsTextStyle: string
valueFormatAbbreviation: DataAbbreviationMode
valueFormatCulture: string
valueFormatCurrencyCode: string
valueFormatMaxFractions: number
valueFormatMinFractions: number
valueFormatMode: DataLegendValueMode
valueFormatSpecifiers: any[]
valueFormatString: string
valueFormatUseGrouping: boolean
valueRowMarginBottom: number
valueRowMarginLeft: number
valueRowMarginRight: number
valueRowMarginTop: number
valueRowVisible: boolean
valueTextColor: string
valueTextMarginBottom: number
valueTextMarginLeft: number
valueTextMarginRight: number
valueTextMarginTop: number
valueTextStyle: string
valueTextUseSeriesColors: boolean
valueTextWhenMissingData: string
width: string

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

get calculateColumnSummary(): EventEmitter<object>

Returns EventEmitter<object>

get i(): XamDataLegend

Returns XamDataLegend

Event raised when styling the group row

get styleGroupRow(): EventEmitter<object>

Returns EventEmitter<object>

Event raised when styling the header row

get styleHeaderRow(): EventEmitter<object>

Returns EventEmitter<object>

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

get styleSeriesColumn(): EventEmitter<object>

Returns EventEmitter<object>

Event raised when styling title and badge in series rows

get styleSeriesRow(): EventEmitter<object>

Returns EventEmitter<object>

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

get styleSummaryColumn(): EventEmitter<object>

Returns EventEmitter<object>

Event raised when styling title in the summary row

get styleSummaryRow(): EventEmitter<object>

Returns EventEmitter<object>

ensureActualBorderThickness(): void

Returns void

ensureBadgeMargin(): void

Returns void

ensureGroupRowMargin(): void

Returns void

ensureGroupTextMargin(): void

Returns void

ensureHeaderRowMargin(): void

Returns void

ensureHeaderTextMargin(): void

Returns void

ensureLabelTextMargin(): void

Returns void

ensureSummaryRowMargin(): void

Returns void

ensureSummaryTitleTextMargin(): void

Returns void

ensureTitleTextMargin(): void

Returns void

ensureUnitsTextMargin(): void

Returns void

ensureValueRowMargin(): void

Returns void

ensureValueTextMargin(): void

Returns void

Returns the legend visuals expressed as a serialized string.

exportSerializedVisualData(): string

Returns string

findByName(name: string): any

Parameters

  • name: string

Returns any

Forces any pending refresh to the legend to be finished.

flush(): void

Returns void

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

Parameters

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

Returns number

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

Parameters

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

Returns string

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

Parameters

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

Returns string

ngAfterContentInit(): void

Returns void

ngOnDestroy(): void

Returns void

Notifies the legend about changes to size

notifySizeChanged(): void

Returns void

updateStyle(): void

Returns void