Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrDataLegendProps

Hierarchy

Hierarchy

  • IIgrDataLegendProps

Properties

Properties

Optional actualBackground

actualBackground?: string

Gets the effective background of the data legend.

Optional actualBadgesVisible

actualBadgesVisible?: string | boolean

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

Optional actualBorderBrush

actualBorderBrush?: string

Gets the effective border brush of the data legend.

Optional actualBorderThicknessBottom

actualBorderThicknessBottom?: string | number

Optional actualBorderThicknessLeft

actualBorderThicknessLeft?: string | number

Optional actualBorderThicknessRight

actualBorderThicknessRight?: string | number

Optional actualBorderThicknessTop

actualBorderThicknessTop?: string | number

Optional actualPixelScalingRatio

actualPixelScalingRatio?: string | 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.

Optional badgeMarginBottom

badgeMarginBottom?: string | number

Optional badgeMarginLeft

badgeMarginLeft?: string | number

Optional badgeMarginRight

badgeMarginRight?: string | number

Optional badgeMarginTop

badgeMarginTop?: string | number

Optional badgeShape

badgeShape?: string | LegendItemBadgeShape

Gets or sets the BadgeShape for the data legend.

Optional calculateColumnSummary

calculateColumnSummary?: ((s, e) => void)

Type declaration

Optional children

children?: ReactNode

Optional contentBackground

contentBackground?: string

Gets or sets the background of the data legend.

Optional contentBorderBrush

contentBorderBrush?: string

Gets or sets the border color of the data legend.

Optional contentBorderThickness

contentBorderThickness?: string | number

Gets or sets the border thickness of the data legend.

Optional excludedColumns

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

Optional excludedSeries

excludedSeries?: string[]

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

Optional groupRowMarginBottom

groupRowMarginBottom?: string | number

Optional groupRowMarginLeft

groupRowMarginLeft?: string | number

Optional groupRowMarginRight

groupRowMarginRight?: string | number

Optional groupRowMarginTop

groupRowMarginTop?: string | number

Optional groupRowVisible

groupRowVisible?: string | boolean

Gets or sets whether to show Header row.

Optional groupTextColor

groupTextColor?: string

Gets or sets the Group text color.

Optional groupTextMarginBottom

groupTextMarginBottom?: string | number

Optional groupTextMarginLeft

groupTextMarginLeft?: string | number

Optional groupTextMarginRight

groupTextMarginRight?: string | number

Optional groupTextMarginTop

groupTextMarginTop?: string | number

Optional groupTextStyle

groupTextStyle?: string

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

Optional headerFormatCulture

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

Optional headerFormatDate

headerFormatDate?: string | 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

Optional headerFormatSpecifiers

headerFormatSpecifiers?: any[]

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

Optional headerFormatString

headerFormatString?: string

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

Optional headerFormatTime

headerFormatTime?: string | 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

Optional headerRowMarginBottom

headerRowMarginBottom?: string | number

Optional headerRowMarginLeft

headerRowMarginLeft?: string | number

Optional headerRowMarginRight

headerRowMarginRight?: string | number

Optional headerRowMarginTop

headerRowMarginTop?: string | number

Optional headerRowVisible

headerRowVisible?: string | boolean

Gets or sets whether to show Header row.

Optional headerText

headerText?: string

Gets or sets the HeaderText for the data legend.

Optional headerTextColor

headerTextColor?: string

Gets or sets the header text color.

Optional headerTextMarginBottom

headerTextMarginBottom?: string | number

Optional headerTextMarginLeft

headerTextMarginLeft?: string | number

Optional headerTextMarginRight

headerTextMarginRight?: string | number

Optional headerTextMarginTop

headerTextMarginTop?: string | number

Optional headerTextStyle

headerTextStyle?: string

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

Optional height

height?: string

Optional includedColumns

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

Optional includedSeries

includedSeries?: string[]

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

Optional isEmbeddedInDataTooltip

isEmbeddedInDataTooltip?: string | boolean

Gets or sets whether the legend is embedded in a DataTooltip

Optional labelDisplayMode

labelDisplayMode?: string | 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

Optional labelTextColor

labelTextColor?: string

Gets or sets the units text color.

Optional labelTextMarginBottom

labelTextMarginBottom?: string | number

Optional labelTextMarginLeft

labelTextMarginLeft?: string | number

Optional labelTextMarginRight

labelTextMarginRight?: string | number

Optional labelTextMarginTop

labelTextMarginTop?: string | number

Optional labelTextStyle

labelTextStyle?: string

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

Optional layoutMode

layoutMode?: string | DataLegendLayoutMode

Gets or sets the layout of content in the data legend

Optional pixelScalingRatio

pixelScalingRatio?: string | 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.

Optional shouldUpdateWhenSeriesDataChanges

shouldUpdateWhenSeriesDataChanges?: string | boolean

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

Optional styleGroupRow

styleGroupRow?: ((s, e) => void)

Type declaration

Optional styleHeaderRow

styleHeaderRow?: ((s, e) => void)

Type declaration

Optional styleSeriesColumn

styleSeriesColumn?: ((s, e) => void)

Type declaration

Optional styleSeriesRow

styleSeriesRow?: ((s, e) => void)

Type declaration

Optional styleSummaryColumn

styleSummaryColumn?: ((s, e) => void)

Type declaration

Optional styleSummaryRow

styleSummaryRow?: ((s, e) => void)

Type declaration

Optional summaryLabelText

summaryLabelText?: string

Gets or sets the units text for the data legend.

Optional summaryLabelTextColor

summaryLabelTextColor?: string

Gets or sets the units text color.

Optional summaryLabelTextStyle

summaryLabelTextStyle?: string

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

Optional summaryRowMarginBottom

summaryRowMarginBottom?: string | number

Optional summaryRowMarginLeft

summaryRowMarginLeft?: string | number

Optional summaryRowMarginRight

summaryRowMarginRight?: string | number

Optional summaryRowMarginTop

summaryRowMarginTop?: string | number

Optional summaryTitleText

summaryTitleText?: string

Gets or sets the SummaryTitleText for the data legend.

Optional summaryTitleTextColor

summaryTitleTextColor?: string

Gets or sets the summary text color.

Optional summaryTitleTextMarginBottom

summaryTitleTextMarginBottom?: string | number

Optional summaryTitleTextMarginLeft

summaryTitleTextMarginLeft?: string | number

Optional summaryTitleTextMarginRight

summaryTitleTextMarginRight?: string | number

Optional summaryTitleTextMarginTop

summaryTitleTextMarginTop?: string | number

Optional summaryTitleTextStyle

summaryTitleTextStyle?: string

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

Optional summaryType

summaryType?: string | DataLegendSummaryType

Gets or sets the SummaryType for the data legend.

Optional summaryUnitsText

summaryUnitsText?: string

Gets or sets the units text for the data legend.

Optional summaryUnitsTextColor

summaryUnitsTextColor?: string

Gets or sets the units text color.

Optional summaryUnitsTextStyle

summaryUnitsTextStyle?: string

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

Optional summaryValueTextColor

summaryValueTextColor?: string

Gets or sets the units text color.

Optional summaryValueTextStyle

summaryValueTextStyle?: string

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

Optional target

target?: any

Optional targetCursorPositionX

targetCursorPositionX?: string | number

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

Optional targetCursorPositionY

targetCursorPositionY?: string | number

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

Optional titleTextColor

titleTextColor?: string

Gets or sets the display text color.

Optional titleTextMarginBottom

titleTextMarginBottom?: string | number

Optional titleTextMarginLeft

titleTextMarginLeft?: string | number

Optional titleTextMarginRight

titleTextMarginRight?: string | number

Optional titleTextMarginTop

titleTextMarginTop?: string | number

Optional titleTextStyle

titleTextStyle?: string

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

Optional unitsDisplayMode

unitsDisplayMode?: string | DataLegendUnitsMode

Gets or sets the UnitsMode for the data legend.

Optional unitsText

unitsText?: string

Gets or sets the units text for the data legend.

Optional unitsTextColor

unitsTextColor?: string

Gets or sets the units text color.

Optional unitsTextMarginBottom

unitsTextMarginBottom?: string | number

Optional unitsTextMarginLeft

unitsTextMarginLeft?: string | number

Optional unitsTextMarginRight

unitsTextMarginRight?: string | number

Optional unitsTextMarginTop

unitsTextMarginTop?: string | number

Optional unitsTextStyle

unitsTextStyle?: string

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

Optional valueFormatAbbreviation

valueFormatAbbreviation?: string | DataAbbreviationMode

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

Optional valueFormatCulture

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

Optional valueFormatCurrencyCode

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

Optional valueFormatMaxFractions

valueFormatMaxFractions?: string | number

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

Optional valueFormatMinFractions

valueFormatMinFractions?: string | number

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

Optional valueFormatMode

valueFormatMode?: string | DataLegendValueMode

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

Optional valueFormatSpecifiers

valueFormatSpecifiers?: any[]

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

Optional valueFormatString

valueFormatString?: string

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

Optional valueFormatUseGrouping

valueFormatUseGrouping?: string | 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

Optional valueRowMarginBottom

valueRowMarginBottom?: string | number

Optional valueRowMarginLeft

valueRowMarginLeft?: string | number

Optional valueRowMarginRight

valueRowMarginRight?: string | number

Optional valueRowMarginTop

valueRowMarginTop?: string | number

Optional valueRowVisible

valueRowVisible?: string | boolean

Gets or sets whether to show series rows.

Optional valueTextColor

valueTextColor?: string

Gets or sets the units text color.

Optional valueTextMarginBottom

valueTextMarginBottom?: string | number

Optional valueTextMarginLeft

valueTextMarginLeft?: string | number

Optional valueTextMarginRight

valueTextMarginRight?: string | number

Optional valueTextMarginTop

valueTextMarginTop?: string | number

Optional valueTextStyle

valueTextStyle?: string

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

Optional valueTextUseSeriesColors

valueTextUseSeriesColors?: string | boolean

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

Optional valueTextWhenMissingData

valueTextWhenMissingData?: string

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

Optional width

width?: string