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

Constructors

Section titled "Constructors"

IgrDataLegend

new IgrDataLegend(props: IIgrDataLegendProps): IgrDataLegend

Returns IgrDataLegend

Properties

Section titled "Properties"

actualBackground

Section titled "actualBackground" 
actualBackground: string

actualBadgesVisible

Section titled "actualBadgesVisible" 
actualBadgesVisible: boolean

actualBorderBrush

Section titled "actualBorderBrush" 
actualBorderBrush: string

actualBorderThicknessBottom

Section titled "actualBorderThicknessBottom" 
actualBorderThicknessBottom: number

actualBorderThicknessLeft

Section titled "actualBorderThicknessLeft" 
actualBorderThicknessLeft: number

actualBorderThicknessRight

Section titled "actualBorderThicknessRight" 
actualBorderThicknessRight: number

actualBorderThicknessTop

Section titled "actualBorderThicknessTop" 
actualBorderThicknessTop: number

actualPixelScalingRatio

Section titled "actualPixelScalingRatio" 
actualPixelScalingRatio: number

badgeMarginBottom

Section titled "badgeMarginBottom" 
badgeMarginBottom: number

badgeMarginLeft

Section titled "badgeMarginLeft" 
badgeMarginLeft: number

badgeMarginRight

Section titled "badgeMarginRight" 
badgeMarginRight: number

badgeMarginTop

Section titled "badgeMarginTop" 
badgeMarginTop: number

badgeShape

Section titled "badgeShape" 
badgeShape: LegendItemBadgeShape

calculateColumnSummary

Section titled "calculateColumnSummary" 
calculateColumnSummary: object

contentBackground

Section titled "contentBackground" 
contentBackground: string

contentBorderBrush

Section titled "contentBorderBrush" 
contentBorderBrush: string

contentBorderThickness

Section titled "contentBorderThickness" 
contentBorderThickness: number

excludedColumns

Section titled "excludedColumns" 
excludedColumns: string[]

excludedSeries

Section titled "excludedSeries" 
excludedSeries: string[]

groupRowMarginBottom

Section titled "groupRowMarginBottom" 
groupRowMarginBottom: number

groupRowMarginLeft

Section titled "groupRowMarginLeft" 
groupRowMarginLeft: number

groupRowMarginRight

Section titled "groupRowMarginRight" 
groupRowMarginRight: number

groupRowMarginTop

Section titled "groupRowMarginTop" 
groupRowMarginTop: number

groupRowVisible

Section titled "groupRowVisible" 
groupRowVisible: boolean

groupTextColor

Section titled "groupTextColor" 
groupTextColor: string

groupTextMarginBottom

Section titled "groupTextMarginBottom" 
groupTextMarginBottom: number

groupTextMarginLeft

Section titled "groupTextMarginLeft" 
groupTextMarginLeft: number

groupTextMarginRight

Section titled "groupTextMarginRight" 
groupTextMarginRight: number

groupTextMarginTop

Section titled "groupTextMarginTop" 
groupTextMarginTop: number

groupTextStyle

Section titled "groupTextStyle" 
groupTextStyle: string

headerFormatCulture

Section titled "headerFormatCulture" 
headerFormatCulture: string

headerFormatDate

Section titled "headerFormatDate" 
headerFormatDate: DataLegendHeaderDateMode

headerFormatSpecifiers

Section titled "headerFormatSpecifiers" 
headerFormatSpecifiers: any[]

headerFormatString

Section titled "headerFormatString" 
headerFormatString: string

headerFormatTime

Section titled "headerFormatTime" 
headerFormatTime: DataLegendHeaderTimeMode

headerRowMarginBottom

Section titled "headerRowMarginBottom" 
headerRowMarginBottom: number

headerRowMarginLeft

Section titled "headerRowMarginLeft" 
headerRowMarginLeft: number

headerRowMarginRight

Section titled "headerRowMarginRight" 
headerRowMarginRight: number

headerRowMarginTop

Section titled "headerRowMarginTop" 
headerRowMarginTop: number

headerRowVisible

Section titled "headerRowVisible" 
headerRowVisible: boolean

headerText

Section titled "headerText" 
headerText: string

headerTextColor

Section titled "headerTextColor" 
headerTextColor: string

headerTextMarginBottom

Section titled "headerTextMarginBottom" 
headerTextMarginBottom: number

headerTextMarginLeft

Section titled "headerTextMarginLeft" 
headerTextMarginLeft: number

headerTextMarginRight

Section titled "headerTextMarginRight" 
headerTextMarginRight: number

headerTextMarginTop

Section titled "headerTextMarginTop" 
headerTextMarginTop: number

headerTextStyle

Section titled "headerTextStyle" 
headerTextStyle: string

height

Section titled "height" 
height: string

includedColumns

Section titled "includedColumns" 
includedColumns: string[]

includedSeries

Section titled "includedSeries" 
includedSeries: string[]

isEmbeddedInDataTooltip

Section titled "isEmbeddedInDataTooltip" 
isEmbeddedInDataTooltip: boolean

labelDisplayMode

Section titled "labelDisplayMode" 
labelDisplayMode: DataLegendLabelMode

labelTextColor

Section titled "labelTextColor" 
labelTextColor: string

labelTextMarginBottom

Section titled "labelTextMarginBottom" 
labelTextMarginBottom: number

labelTextMarginLeft

Section titled "labelTextMarginLeft" 
labelTextMarginLeft: number

labelTextMarginRight

Section titled "labelTextMarginRight" 
labelTextMarginRight: number

labelTextMarginTop

Section titled "labelTextMarginTop" 
labelTextMarginTop: number

labelTextStyle

Section titled "labelTextStyle" 
labelTextStyle: string

layoutMode

Section titled "layoutMode" 
layoutMode: DataLegendLayoutMode

pixelScalingRatio

Section titled "pixelScalingRatio" 
pixelScalingRatio: number

shouldUpdateWhenSeriesDataChanges

Section titled "shouldUpdateWhenSeriesDataChanges" 
shouldUpdateWhenSeriesDataChanges: boolean

styleGroupRow

Section titled "styleGroupRow" 
styleGroupRow: object

styleHeaderRow

Section titled "styleHeaderRow" 
styleHeaderRow: object

styleSeriesColumn

Section titled "styleSeriesColumn" 
styleSeriesColumn: object

styleSeriesRow

Section titled "styleSeriesRow" 
styleSeriesRow: object

styleSummaryColumn

Section titled "styleSummaryColumn" 
styleSummaryColumn: object

styleSummaryRow

Section titled "styleSummaryRow" 
styleSummaryRow: object

summaryLabelText

Section titled "summaryLabelText" 
summaryLabelText: string

summaryLabelTextColor

Section titled "summaryLabelTextColor" 
summaryLabelTextColor: string

summaryLabelTextStyle

Section titled "summaryLabelTextStyle" 
summaryLabelTextStyle: string

summaryRowMarginBottom

Section titled "summaryRowMarginBottom" 
summaryRowMarginBottom: number

summaryRowMarginLeft

Section titled "summaryRowMarginLeft" 
summaryRowMarginLeft: number

summaryRowMarginRight

Section titled "summaryRowMarginRight" 
summaryRowMarginRight: number

summaryRowMarginTop

Section titled "summaryRowMarginTop" 
summaryRowMarginTop: number

summaryTitleText

Section titled "summaryTitleText" 
summaryTitleText: string

summaryTitleTextColor

Section titled "summaryTitleTextColor" 
summaryTitleTextColor: string

summaryTitleTextMarginBottom

Section titled "summaryTitleTextMarginBottom" 
summaryTitleTextMarginBottom: number

summaryTitleTextMarginLeft

Section titled "summaryTitleTextMarginLeft" 
summaryTitleTextMarginLeft: number

summaryTitleTextMarginRight

Section titled "summaryTitleTextMarginRight" 
summaryTitleTextMarginRight: number

summaryTitleTextMarginTop

Section titled "summaryTitleTextMarginTop" 
summaryTitleTextMarginTop: number

summaryTitleTextStyle

Section titled "summaryTitleTextStyle" 
summaryTitleTextStyle: string

summaryType

Section titled "summaryType" 
summaryType: DataLegendSummaryType

summaryUnitsText

Section titled "summaryUnitsText" 
summaryUnitsText: string

summaryUnitsTextColor

Section titled "summaryUnitsTextColor" 
summaryUnitsTextColor: string

summaryUnitsTextStyle

Section titled "summaryUnitsTextStyle" 
summaryUnitsTextStyle: string

summaryValueTextColor

Section titled "summaryValueTextColor" 
summaryValueTextColor: string

summaryValueTextStyle

Section titled "summaryValueTextStyle" 
summaryValueTextStyle: string

target

Section titled "target" 
target: any

targetCursorPositionX

Section titled "targetCursorPositionX" 
targetCursorPositionX: number

targetCursorPositionY

Section titled "targetCursorPositionY" 
targetCursorPositionY: number

titleTextColor

Section titled "titleTextColor" 
titleTextColor: string

titleTextMarginBottom

Section titled "titleTextMarginBottom" 
titleTextMarginBottom: number

titleTextMarginLeft

Section titled "titleTextMarginLeft" 
titleTextMarginLeft: number

titleTextMarginRight

Section titled "titleTextMarginRight" 
titleTextMarginRight: number

titleTextMarginTop

Section titled "titleTextMarginTop" 
titleTextMarginTop: number

titleTextStyle

Section titled "titleTextStyle" 
titleTextStyle: string

unitsDisplayMode

Section titled "unitsDisplayMode" 
unitsDisplayMode: DataLegendUnitsMode

unitsText

Section titled "unitsText" 
unitsText: string

unitsTextColor

Section titled "unitsTextColor" 
unitsTextColor: string

unitsTextMarginBottom

Section titled "unitsTextMarginBottom" 
unitsTextMarginBottom: number

unitsTextMarginLeft

Section titled "unitsTextMarginLeft" 
unitsTextMarginLeft: number

unitsTextMarginRight

Section titled "unitsTextMarginRight" 
unitsTextMarginRight: number

unitsTextMarginTop

Section titled "unitsTextMarginTop" 
unitsTextMarginTop: number

unitsTextStyle

Section titled "unitsTextStyle" 
unitsTextStyle: string

valueFormatAbbreviation

Section titled "valueFormatAbbreviation" 
valueFormatAbbreviation: DataAbbreviationMode

valueFormatCulture

Section titled "valueFormatCulture" 
valueFormatCulture: string

valueFormatCurrencyCode

Section titled "valueFormatCurrencyCode" 
valueFormatCurrencyCode: string

valueFormatMaxFractions

Section titled "valueFormatMaxFractions" 
valueFormatMaxFractions: number

valueFormatMinFractions

Section titled "valueFormatMinFractions" 
valueFormatMinFractions: number

valueFormatMode

Section titled "valueFormatMode" 
valueFormatMode: DataLegendValueMode

valueFormatSpecifiers

Section titled "valueFormatSpecifiers" 
valueFormatSpecifiers: any[]

valueFormatString

Section titled "valueFormatString" 
valueFormatString: string

valueFormatUseGrouping

Section titled "valueFormatUseGrouping" 
valueFormatUseGrouping: boolean

valueRowMarginBottom

Section titled "valueRowMarginBottom" 
valueRowMarginBottom: number

valueRowMarginLeft

Section titled "valueRowMarginLeft" 
valueRowMarginLeft: number

valueRowMarginRight

Section titled "valueRowMarginRight" 
valueRowMarginRight: number

valueRowMarginTop

Section titled "valueRowMarginTop" 
valueRowMarginTop: number

valueRowVisible

Section titled "valueRowVisible" 
valueRowVisible: boolean

valueTextColor

Section titled "valueTextColor" 
valueTextColor: string

valueTextMarginBottom

Section titled "valueTextMarginBottom" 
valueTextMarginBottom: number

valueTextMarginLeft

Section titled "valueTextMarginLeft" 
valueTextMarginLeft: number

valueTextMarginRight

Section titled "valueTextMarginRight" 
valueTextMarginRight: number

valueTextMarginTop

Section titled "valueTextMarginTop" 
valueTextMarginTop: number

valueTextStyle

Section titled "valueTextStyle" 
valueTextStyle: string

valueTextUseSeriesColors

Section titled "valueTextUseSeriesColors" 
valueTextUseSeriesColors: boolean

valueTextWhenMissingData

Section titled "valueTextWhenMissingData" 
valueTextWhenMissingData: string

width

Section titled "width" 
width: string

Accessors

Section titled "Accessors"

i

Section titled "i" 
get i(): XamDataLegend

Returns XamDataLegend

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

ensureActualBorderThickness

Section titled "ensureActualBorderThickness" 
ensureActualBorderThickness(): void

Returns void

ensureBadgeMargin

Section titled "ensureBadgeMargin" 
ensureBadgeMargin(): void

Returns void

ensureGroupRowMargin

Section titled "ensureGroupRowMargin" 
ensureGroupRowMargin(): void

Returns void

ensureGroupTextMargin

Section titled "ensureGroupTextMargin" 
ensureGroupTextMargin(): void

Returns void

ensureHeaderRowMargin

Section titled "ensureHeaderRowMargin" 
ensureHeaderRowMargin(): void

Returns void

ensureHeaderTextMargin

Section titled "ensureHeaderTextMargin" 
ensureHeaderTextMargin(): void

Returns void

ensureLabelTextMargin

Section titled "ensureLabelTextMargin" 
ensureLabelTextMargin(): void

Returns void

ensureSummaryRowMargin

Section titled "ensureSummaryRowMargin" 
ensureSummaryRowMargin(): void

Returns void

ensureSummaryTitleTextMargin

Section titled "ensureSummaryTitleTextMargin" 
ensureSummaryTitleTextMargin(): void

Returns void

ensureTitleTextMargin

Section titled "ensureTitleTextMargin" 
ensureTitleTextMargin(): void

Returns void

ensureUnitsTextMargin

Section titled "ensureUnitsTextMargin" 
ensureUnitsTextMargin(): void

Returns void

ensureValueRowMargin

Section titled "ensureValueRowMargin" 
ensureValueRowMargin(): void

Returns void

ensureValueTextMargin

Section titled "ensureValueTextMargin" 
ensureValueTextMargin(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Returns the legend visuals expressed as a serialized string.

exportSerializedVisualData(): string

Returns string

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

flush

Section titled "flush"

Forces any pending refresh to the legend to be finished.

flush(): void

Returns void

getAbbreviatedNumber

Section titled "getAbbreviatedNumber" 
getAbbreviatedNumber(number: number, mode: any, minDigits: number, maxDigits: number): number

Parameters

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

Returns number

getAbbreviatedString

Section titled "getAbbreviatedString" 
getAbbreviatedString(number: number, mode: any, minDigits: number, maxDigits: number): string

Parameters

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

Returns string

getAbbreviatedSymbol

Section titled "getAbbreviatedSymbol" 
getAbbreviatedSymbol(number: number, mode: any, minDigits: number, maxDigits: number): string

Parameters

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

Returns string

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

notifySizeChanged

Section titled "notifySizeChanged"

Notifies the legend about changes to size

notifySizeChanged(): void

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

updateStyle

Section titled "updateStyle" 
updateStyle(): void

Returns void