IIgrDataLegendProps

Properties

Optional actualBackground

Gets the effective background of the data legend.

actualBackground?: string

Optional actualBadgesVisible

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

actualBadgesVisible?: string | boolean

Optional actualBorderBrush

Gets the effective border brush of the data legend.

actualBorderBrush?: string

Optional actualBorderThicknessBottom

actualBorderThicknessBottom?: string | number

Optional actualBorderThicknessLeft

actualBorderThicknessLeft?: string | number

Optional actualBorderThicknessRight

actualBorderThicknessRight?: string | number

Optional actualBorderThicknessTop

actualBorderThicknessTop?: string | number

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

actualPixelScalingRatio?: string | number

Optional badgeMarginBottom

badgeMarginBottom?: string | number

Optional badgeMarginLeft

badgeMarginLeft?: string | number

Optional badgeMarginRight

badgeMarginRight?: string | number

Optional badgeMarginTop

badgeMarginTop?: string | number

Optional badgeShape

Gets or sets the BadgeShape for the data legend.

badgeShape?: any

Optional calculateColumnSummary

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

calculateColumnSummary?: object

Optional children

children?: ReactNode

Optional contentBackground

Gets or sets the background of the data legend.

contentBackground?: string

Optional contentBorderBrush

Gets or sets the border color of the data legend.

contentBorderBrush?: string

Optional contentBorderThickness

Gets or sets the border thickness of the data legend.

contentBorderThickness?: string | number

Optional 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

excludedColumns?: string[]

Optional 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

excludedSeries?: string[]

Optional groupRowMarginBottom

groupRowMarginBottom?: string | number

Optional groupRowMarginLeft

groupRowMarginLeft?: string | number

Optional groupRowMarginRight

groupRowMarginRight?: string | number

Optional groupRowMarginTop

groupRowMarginTop?: string | number

Optional groupRowVisible

Gets or sets whether to show Header row.

groupRowVisible?: string | boolean

Optional groupTextColor

Gets or sets the Group text color.

groupTextColor?: string

Optional groupTextMarginBottom

groupTextMarginBottom?: string | number

Optional groupTextMarginLeft

groupTextMarginLeft?: string | number

Optional groupTextMarginRight

groupTextMarginRight?: string | number

Optional groupTextMarginTop

groupTextMarginTop?: string | number

Optional groupTextStyle

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

groupTextStyle?: string

Optional 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

headerFormatCulture?: string

Optional 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

headerFormatDate?: any

Optional headerFormatSpecifiers

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

headerFormatSpecifiers?: any[]

Optional headerFormatString

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

headerFormatString?: string

Optional 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

headerFormatTime?: any

Optional headerRowMarginBottom

headerRowMarginBottom?: string | number

Optional headerRowMarginLeft

headerRowMarginLeft?: string | number

Optional headerRowMarginRight

headerRowMarginRight?: string | number

Optional headerRowMarginTop

headerRowMarginTop?: string | number

Optional headerRowVisible

Gets or sets whether to show Header row.

headerRowVisible?: string | boolean

Optional headerText

Gets or sets the HeaderText for the data legend.

headerText?: string

Optional headerTextColor

Gets or sets the header text color.

headerTextColor?: string

Optional headerTextMarginBottom

headerTextMarginBottom?: string | number

Optional headerTextMarginLeft

headerTextMarginLeft?: string | number

Optional headerTextMarginRight

headerTextMarginRight?: string | number

Optional headerTextMarginTop

headerTextMarginTop?: string | number

Optional headerTextStyle

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

headerTextStyle?: string

Optional height

height?: string

Optional 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

includedColumns?: string[]

Optional 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

includedSeries?: string[]

Optional isEmbeddedInDataTooltip

Gets or sets whether the legend is embedded in a DataTooltip

isEmbeddedInDataTooltip?: string | boolean

Optional 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

labelDisplayMode?: any

Optional labelTextColor

Gets or sets the units text color.

labelTextColor?: string

Optional labelTextMarginBottom

labelTextMarginBottom?: string | number

Optional labelTextMarginLeft

labelTextMarginLeft?: string | number

Optional labelTextMarginRight

labelTextMarginRight?: string | number

Optional labelTextMarginTop

labelTextMarginTop?: string | number

Optional labelTextStyle

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

labelTextStyle?: string

Optional layoutMode

Gets or sets the layout of content in the data legend

layoutMode?: any

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

pixelScalingRatio?: string | number

Optional shouldUpdateWhenSeriesDataChanges

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

shouldUpdateWhenSeriesDataChanges?: string | boolean

Optional styleGroupRow

Event raised when styling the group row

styleGroupRow?: object

Optional styleHeaderRow

Event raised when styling the header row

styleHeaderRow?: object

Optional styleSeriesColumn

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

styleSeriesColumn?: object

Optional styleSeriesRow

Event raised when styling title and badge in series rows

styleSeriesRow?: object

Optional styleSummaryColumn

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

styleSummaryColumn?: object

Optional styleSummaryRow

Event raised when styling title in the summary row

styleSummaryRow?: object

Optional summaryLabelText

Gets or sets the units text for the data legend.

summaryLabelText?: string

Optional summaryLabelTextColor

Gets or sets the units text color.

summaryLabelTextColor?: string

Optional summaryLabelTextStyle

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

summaryLabelTextStyle?: string

Optional summaryRowMarginBottom

summaryRowMarginBottom?: string | number

Optional summaryRowMarginLeft

summaryRowMarginLeft?: string | number

Optional summaryRowMarginRight

summaryRowMarginRight?: string | number

Optional summaryRowMarginTop

summaryRowMarginTop?: string | number

Optional summaryTitleText

Gets or sets the SummaryTitleText for the data legend.

summaryTitleText?: string

Optional summaryTitleTextColor

Gets or sets the summary text color.

summaryTitleTextColor?: string

Optional summaryTitleTextMarginBottom

summaryTitleTextMarginBottom?: string | number

Optional summaryTitleTextMarginLeft

summaryTitleTextMarginLeft?: string | number

Optional summaryTitleTextMarginRight

summaryTitleTextMarginRight?: string | number

Optional summaryTitleTextMarginTop

summaryTitleTextMarginTop?: string | number

Optional summaryTitleTextStyle

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

summaryTitleTextStyle?: string

Optional summaryType

Gets or sets the SummaryType for the data legend.

summaryType?: any

Optional summaryUnitsText

Gets or sets the units text for the data legend.

summaryUnitsText?: string

Optional summaryUnitsTextColor

Gets or sets the units text color.

summaryUnitsTextColor?: string

Optional summaryUnitsTextStyle

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

summaryUnitsTextStyle?: string

Optional summaryValueTextColor

Gets or sets the units text color.

summaryValueTextColor?: string

Optional summaryValueTextStyle

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

summaryValueTextStyle?: string

Optional target

target?: any

Optional targetCursorPositionX

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

targetCursorPositionX?: string | number

Optional targetCursorPositionY

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

targetCursorPositionY?: string | number

Optional titleTextColor

Gets or sets the display text color.

titleTextColor?: string

Optional titleTextMarginBottom

titleTextMarginBottom?: string | number

Optional titleTextMarginLeft

titleTextMarginLeft?: string | number

Optional titleTextMarginRight

titleTextMarginRight?: string | number

Optional titleTextMarginTop

titleTextMarginTop?: string | number

Optional titleTextStyle

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

titleTextStyle?: string

Optional unitsDisplayMode

Gets or sets the UnitsMode for the data legend.

unitsDisplayMode?: any

Optional unitsText

Gets or sets the units text for the data legend.

unitsText?: string

Optional unitsTextColor

Gets or sets the units text color.

unitsTextColor?: string

Optional unitsTextMarginBottom

unitsTextMarginBottom?: string | number

Optional unitsTextMarginLeft

unitsTextMarginLeft?: string | number

Optional unitsTextMarginRight

unitsTextMarginRight?: string | number

Optional unitsTextMarginTop

unitsTextMarginTop?: string | number

Optional unitsTextStyle

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

unitsTextStyle?: string

Optional valueFormatAbbreviation

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

valueFormatAbbreviation?: any

Optional 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

valueFormatCulture?: string

Optional 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

valueFormatCurrencyCode?: string

Optional valueFormatMaxFractions

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

valueFormatMaxFractions?: string | number

Optional valueFormatMinFractions

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

valueFormatMinFractions?: string | number

Optional valueFormatMode

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

valueFormatMode?: any

Optional valueFormatSpecifiers

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

valueFormatSpecifiers?: any[]

Optional valueFormatString

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

valueFormatString?: string

Optional 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

valueFormatUseGrouping?: string | boolean

Optional valueRowMarginBottom

valueRowMarginBottom?: string | number

Optional valueRowMarginLeft

valueRowMarginLeft?: string | number

Optional valueRowMarginRight

valueRowMarginRight?: string | number

Optional valueRowMarginTop

valueRowMarginTop?: string | number

Optional valueRowVisible

Gets or sets whether to show series rows.

valueRowVisible?: string | boolean

Optional valueTextColor

Gets or sets the units text color.

valueTextColor?: string

Optional valueTextMarginBottom

valueTextMarginBottom?: string | number

Optional valueTextMarginLeft

valueTextMarginLeft?: string | number

Optional valueTextMarginRight

valueTextMarginRight?: string | number

Optional valueTextMarginTop

valueTextMarginTop?: string | number

Optional valueTextStyle

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

valueTextStyle?: string

Optional valueTextUseSeriesColors

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

valueTextUseSeriesColors?: string | boolean

Optional valueTextWhenMissingData

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

valueTextWhenMissingData?: string

Optional width

width?: string