Class IgbDataLegend

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

Inheritance
System.Object
BaseRendererControl
IgbDataLegend
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataLegend : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbDataLegend()

Declaration
public IgbDataLegend()

Properties

ActualBackground

Gets the effective background of the data legend.

Declaration
public string ActualBackground { get; set; }
Property Value
Type Description
System.String

ActualBadgesVisible

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

Declaration
public bool ActualBadgesVisible { get; set; }
Property Value
Type Description
System.Boolean

ActualBorderBrush

Gets the effective border brush of the data legend.

Declaration
public string ActualBorderBrush { get; set; }
Property Value
Type Description
System.String

ActualBorderThicknessBottom

Declaration
public double ActualBorderThicknessBottom { get; set; }
Property Value
Type Description
System.Double

ActualBorderThicknessLeft

Declaration
public double ActualBorderThicknessLeft { get; set; }
Property Value
Type Description
System.Double

ActualBorderThicknessRight

Declaration
public double ActualBorderThicknessRight { get; set; }
Property Value
Type Description
System.Double

ActualBorderThicknessTop

Declaration
public double ActualBorderThicknessTop { get; set; }
Property Value
Type Description
System.Double

ActualPixelScalingRatio

Gets the actual pixel scaling ratio used to affect the pixel density of the control.

Declaration
public double ActualPixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

BadgeMarginBottom

Declaration
public double BadgeMarginBottom { get; set; }
Property Value
Type Description
System.Double

BadgeMarginLeft

Declaration
public double BadgeMarginLeft { get; set; }
Property Value
Type Description
System.Double

BadgeMarginRight

Declaration
public double BadgeMarginRight { get; set; }
Property Value
Type Description
System.Double

BadgeMarginTop

Declaration
public double BadgeMarginTop { get; set; }
Property Value
Type Description
System.Double

BadgeShape

Gets or sets the BadgeShape for the data legend.

Declaration
public LegendItemBadgeShape BadgeShape { get; set; }
Property Value
Type Description
LegendItemBadgeShape

CalculateColumnSummary

Declaration
public EventCallback<IgbDataLegendSummaryEventArgs> CalculateColumnSummary { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendSummaryEventArgs>

CalculateColumnSummaryScript

Declaration
public string CalculateColumnSummaryScript { get; set; }
Property Value
Type Description
System.String

ContentBackground

Gets or sets the background of the data legend.

Declaration
public string ContentBackground { get; set; }
Property Value
Type Description
System.String

ContentBorderBrush

Gets or sets the border color of the data legend.

Declaration
public string ContentBorderBrush { get; set; }
Property Value
Type Description
System.String

ContentBorderThickness

Gets or sets the border thickness of the data legend.

Declaration
public double ContentBorderThickness { get; set; }
Property Value
Type Description
System.Double

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

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"

Declaration
public string[] ExcludedColumns { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedColumns property takes precedence over values of IncludedColumns property

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"

Declaration
public string[] ExcludedSeries { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedSeries property takes precedence over values of IncludedSeries property

GroupRowMarginBottom

Declaration
public double GroupRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

GroupRowMarginLeft

Declaration
public double GroupRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

GroupRowMarginRight

Declaration
public double GroupRowMarginRight { get; set; }
Property Value
Type Description
System.Double

GroupRowMarginTop

Declaration
public double GroupRowMarginTop { get; set; }
Property Value
Type Description
System.Double

GroupRowVisible

Gets or sets whether to show Header row.

Declaration
public bool GroupRowVisible { get; set; }
Property Value
Type Description
System.Boolean

GroupTextColor

Gets or sets the Group text color.

Declaration
public string GroupTextColor { get; set; }
Property Value
Type Description
System.String

GroupTextFontFamily

Declaration
public string GroupTextFontFamily { get; set; }
Property Value
Type Description
System.String

GroupTextFontSize

Declaration
public double GroupTextFontSize { get; set; }
Property Value
Type Description
System.Double

GroupTextFontStyle

Declaration
public string GroupTextFontStyle { get; set; }
Property Value
Type Description
System.String

GroupTextFontWeight

Declaration
public string GroupTextFontWeight { get; set; }
Property Value
Type Description
System.String

GroupTextMarginBottom

Declaration
public double GroupTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

GroupTextMarginLeft

Declaration
public double GroupTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

GroupTextMarginRight

Declaration
public double GroupTextMarginRight { get; set; }
Property Value
Type Description
System.Double

GroupTextMarginTop

Declaration
public double GroupTextMarginTop { get; set; }
Property Value
Type Description
System.Double

HeaderFormatCulture

Gets or sets globalization culture applied to header only when it displays dates that are fetched from date/time axes

Declaration
public string HeaderFormatCulture { get; set; }
Property Value
Type Description
System.String
Remarks

This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

HeaderFormatDate

Gets or sets date format for the header only when it displays dates that are fetched from date/time axes

Declaration
public DataLegendHeaderDateMode HeaderFormatDate { get; set; }
Property Value
Type Description
DataLegendHeaderDateMode
Remarks

This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

HeaderFormatSpecifiers

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

Declaration
public IgbFormatSpecifierCollection HeaderFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

HeaderFormatString

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

Declaration
public string HeaderFormatString { get; set; }
Property Value
Type Description
System.String

HeaderFormatTime

Gets or sets time format for the header only when it displays dates that are fetched from date/time axes

Declaration
public DataLegendHeaderTimeMode HeaderFormatTime { get; set; }
Property Value
Type Description
DataLegendHeaderTimeMode
Remarks

This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

HeaderRowMarginBottom

Declaration
public double HeaderRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

HeaderRowMarginLeft

Declaration
public double HeaderRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

HeaderRowMarginRight

Declaration
public double HeaderRowMarginRight { get; set; }
Property Value
Type Description
System.Double

HeaderRowMarginTop

Declaration
public double HeaderRowMarginTop { get; set; }
Property Value
Type Description
System.Double

HeaderRowVisible

Gets or sets whether to show Header row.

Declaration
public bool HeaderRowVisible { get; set; }
Property Value
Type Description
System.Boolean

HeaderText

Gets or sets the HeaderText for the data legend.

Declaration
public string HeaderText { get; set; }
Property Value
Type Description
System.String

HeaderTextColor

Gets or sets the header text color.

Declaration
public string HeaderTextColor { get; set; }
Property Value
Type Description
System.String

HeaderTextFontFamily

Declaration
public string HeaderTextFontFamily { get; set; }
Property Value
Type Description
System.String

HeaderTextFontSize

Declaration
public double HeaderTextFontSize { get; set; }
Property Value
Type Description
System.Double

HeaderTextFontStyle

Declaration
public string HeaderTextFontStyle { get; set; }
Property Value
Type Description
System.String

HeaderTextFontWeight

Declaration
public string HeaderTextFontWeight { get; set; }
Property Value
Type Description
System.String

HeaderTextMarginBottom

Declaration
public double HeaderTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

HeaderTextMarginLeft

Declaration
public double HeaderTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

HeaderTextMarginRight

Declaration
public double HeaderTextMarginRight { get; set; }
Property Value
Type Description
System.Double

HeaderTextMarginTop

Declaration
public double HeaderTextMarginTop { get; set; }
Property Value
Type Description
System.Double

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"

Declaration
public string[] IncludedColumns { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedColumns property takes precedence over values of IncludedColumns property

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"

Declaration
public string[] IncludedSeries { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedSeries property takes precedence over values of IncludedSeries property

IsEmbeddedInDataTooltip

Gets or sets whether the legend is embedded in a DataTooltip

Declaration
public bool IsEmbeddedInDataTooltip { get; set; }
Property Value
Type Description
System.Boolean

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

Declaration
public DataLegendLabelMode LabelDisplayMode { get; set; }
Property Value
Type Description
DataLegendLabelMode

LabelTextColor

Gets or sets the units text color.

Declaration
public string LabelTextColor { get; set; }
Property Value
Type Description
System.String

LabelTextFontFamily

Declaration
public string LabelTextFontFamily { get; set; }
Property Value
Type Description
System.String

LabelTextFontSize

Declaration
public double LabelTextFontSize { get; set; }
Property Value
Type Description
System.Double

LabelTextFontStyle

Declaration
public string LabelTextFontStyle { get; set; }
Property Value
Type Description
System.String

LabelTextFontWeight

Declaration
public string LabelTextFontWeight { get; set; }
Property Value
Type Description
System.String

LabelTextMarginBottom

Declaration
public double LabelTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

LabelTextMarginLeft

Declaration
public double LabelTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

LabelTextMarginRight

Declaration
public double LabelTextMarginRight { get; set; }
Property Value
Type Description
System.Double

LabelTextMarginTop

Declaration
public double LabelTextMarginTop { get; set; }
Property Value
Type Description
System.Double

LayoutMode

Gets or sets the layout of content in the data legend

Declaration
public DataLegendLayoutMode LayoutMode { get; set; }
Property Value
Type Description
DataLegendLayoutMode

PixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control.

Declaration
public double PixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

ShouldUpdateWhenSeriesDataChanges

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

Declaration
public bool ShouldUpdateWhenSeriesDataChanges { get; set; }
Property Value
Type Description
System.Boolean

StyleGroupRow

Declaration
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleGroupRow { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendStylingRowEventArgs>

StyleGroupRowScript

Declaration
public string StyleGroupRowScript { get; set; }
Property Value
Type Description
System.String

StyleHeaderRow

Declaration
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleHeaderRow { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendStylingRowEventArgs>

StyleHeaderRowScript

Declaration
public string StyleHeaderRowScript { get; set; }
Property Value
Type Description
System.String

StyleSeriesColumn

Declaration
public EventCallback<IgbDataLegendStylingColumnEventArgs> StyleSeriesColumn { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendStylingColumnEventArgs>

StyleSeriesColumnScript

Declaration
public string StyleSeriesColumnScript { get; set; }
Property Value
Type Description
System.String

StyleSeriesRow

Declaration
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleSeriesRow { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendStylingRowEventArgs>

StyleSeriesRowScript

Declaration
public string StyleSeriesRowScript { get; set; }
Property Value
Type Description
System.String

StyleSummaryColumn

Declaration
public EventCallback<IgbDataLegendStylingColumnEventArgs> StyleSummaryColumn { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendStylingColumnEventArgs>

StyleSummaryColumnScript

Declaration
public string StyleSummaryColumnScript { get; set; }
Property Value
Type Description
System.String

StyleSummaryRow

Declaration
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleSummaryRow { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataLegendStylingRowEventArgs>

StyleSummaryRowScript

Declaration
public string StyleSummaryRowScript { get; set; }
Property Value
Type Description
System.String

SummaryLabelText

Gets or sets the units text for the data legend.

Declaration
public string SummaryLabelText { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextColor

Gets or sets the units text color.

Declaration
public string SummaryLabelTextColor { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextFontFamily

Declaration
public string SummaryLabelTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextFontSize

Declaration
public double SummaryLabelTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryLabelTextFontStyle

Declaration
public string SummaryLabelTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextFontWeight

Declaration
public string SummaryLabelTextFontWeight { get; set; }
Property Value
Type Description
System.String

SummaryRowMarginBottom

Declaration
public double SummaryRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

SummaryRowMarginLeft

Declaration
public double SummaryRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

SummaryRowMarginRight

Declaration
public double SummaryRowMarginRight { get; set; }
Property Value
Type Description
System.Double

SummaryRowMarginTop

Declaration
public double SummaryRowMarginTop { get; set; }
Property Value
Type Description
System.Double

SummaryTitleText

Gets or sets the SummaryTitleText for the data legend.

Declaration
public string SummaryTitleText { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextColor

Gets or sets the summary text color.

Declaration
public string SummaryTitleTextColor { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextFontFamily

Declaration
public string SummaryTitleTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextFontSize

Declaration
public double SummaryTitleTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextFontStyle

Declaration
public string SummaryTitleTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextFontWeight

Declaration
public string SummaryTitleTextFontWeight { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextMarginBottom

Declaration
public double SummaryTitleTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextMarginLeft

Declaration
public double SummaryTitleTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextMarginRight

Declaration
public double SummaryTitleTextMarginRight { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextMarginTop

Declaration
public double SummaryTitleTextMarginTop { get; set; }
Property Value
Type Description
System.Double

SummaryType

Gets or sets the SummaryType for the data legend.

Declaration
public DataLegendSummaryType SummaryType { get; set; }
Property Value
Type Description
DataLegendSummaryType

SummaryUnitsText

Gets or sets the units text for the data legend.

Declaration
public string SummaryUnitsText { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextColor

Gets or sets the units text color.

Declaration
public string SummaryUnitsTextColor { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextFontFamily

Declaration
public string SummaryUnitsTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextFontSize

Declaration
public double SummaryUnitsTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryUnitsTextFontStyle

Declaration
public string SummaryUnitsTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextFontWeight

Declaration
public string SummaryUnitsTextFontWeight { get; set; }
Property Value
Type Description
System.String

SummaryValueTextColor

Gets or sets the units text color.

Declaration
public string SummaryValueTextColor { get; set; }
Property Value
Type Description
System.String

SummaryValueTextFontFamily

Declaration
public string SummaryValueTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryValueTextFontSize

Declaration
public double SummaryValueTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryValueTextFontStyle

Declaration
public string SummaryValueTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryValueTextFontWeight

Declaration
public string SummaryValueTextFontWeight { get; set; }
Property Value
Type Description
System.String

Target

Gets or sets the target for the data legend.

Declaration
public object Target { get; set; }
Property Value
Type Description
System.Object

TargetCursorPositionX

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

Declaration
public double TargetCursorPositionX { get; set; }
Property Value
Type Description
System.Double

TargetCursorPositionY

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

Declaration
public double TargetCursorPositionY { get; set; }
Property Value
Type Description
System.Double

TargetScript

Provides a means of setting Target in the JavaScript environment.

Declaration
public string TargetScript { get; set; }
Property Value
Type Description
System.String

TitleTextColor

Gets or sets the display text color.

Declaration
public string TitleTextColor { get; set; }
Property Value
Type Description
System.String

TitleTextFontFamily

Declaration
public string TitleTextFontFamily { get; set; }
Property Value
Type Description
System.String

TitleTextFontSize

Declaration
public double TitleTextFontSize { get; set; }
Property Value
Type Description
System.Double

TitleTextFontStyle

Declaration
public string TitleTextFontStyle { get; set; }
Property Value
Type Description
System.String

TitleTextFontWeight

Declaration
public string TitleTextFontWeight { get; set; }
Property Value
Type Description
System.String

TitleTextMarginBottom

Declaration
public double TitleTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

TitleTextMarginLeft

Declaration
public double TitleTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

TitleTextMarginRight

Declaration
public double TitleTextMarginRight { get; set; }
Property Value
Type Description
System.Double

TitleTextMarginTop

Declaration
public double TitleTextMarginTop { get; set; }
Property Value
Type Description
System.Double

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UnitsDisplayMode

Gets or sets the UnitsMode for the data legend.

Declaration
public DataLegendUnitsMode UnitsDisplayMode { get; set; }
Property Value
Type Description
DataLegendUnitsMode

UnitsText

Gets or sets the units text for the data legend.

Declaration
public string UnitsText { get; set; }
Property Value
Type Description
System.String

UnitsTextColor

Gets or sets the units text color.

Declaration
public string UnitsTextColor { get; set; }
Property Value
Type Description
System.String

UnitsTextFontFamily

Declaration
public string UnitsTextFontFamily { get; set; }
Property Value
Type Description
System.String

UnitsTextFontSize

Declaration
public double UnitsTextFontSize { get; set; }
Property Value
Type Description
System.Double

UnitsTextFontStyle

Declaration
public string UnitsTextFontStyle { get; set; }
Property Value
Type Description
System.String

UnitsTextFontWeight

Declaration
public string UnitsTextFontWeight { get; set; }
Property Value
Type Description
System.String

UnitsTextMarginBottom

Declaration
public double UnitsTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

UnitsTextMarginLeft

Declaration
public double UnitsTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

UnitsTextMarginRight

Declaration
public double UnitsTextMarginRight { get; set; }
Property Value
Type Description
System.Double

UnitsTextMarginTop

Declaration
public double UnitsTextMarginTop { get; set; }
Property Value
Type Description
System.Double

ValueFormatAbbreviation

Gets or sets mode for abbreviating large numbers displayed in the legend

Declaration
public DataAbbreviationMode ValueFormatAbbreviation { get; set; }
Property Value
Type Description
DataAbbreviationMode
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

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

Declaration
public string ValueFormatCulture { get; set; }
Property Value
Type Description
System.String
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatCurrencyCode

Gets or sets the currency code used for displaying currency symbol next to values, e.g. USD for $, EUR for €

Declaration
public string ValueFormatCurrencyCode { get; set; }
Property Value
Type Description
System.String
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatMaxFractions

Gets or sets maximum digits for formatting numbers displayed in the legend

Declaration
public int ValueFormatMaxFractions { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatMinFractions

Gets or sets minimum digits for formatting numbers displayed in the legend

Declaration
public int ValueFormatMinFractions { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatMode

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

Declaration
public DataLegendValueMode ValueFormatMode { get; set; }
Property Value
Type Description
DataLegendValueMode

ValueFormatSpecifiers

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

Declaration
public IgbFormatSpecifierCollection ValueFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

ValueFormatString

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

Declaration
public string ValueFormatString { get; set; }
Property Value
Type Description
System.String

ValueFormatUseGrouping

Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000

Declaration
public bool ValueFormatUseGrouping { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueRowMarginBottom

Declaration
public double ValueRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

ValueRowMarginLeft

Declaration
public double ValueRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

ValueRowMarginRight

Declaration
public double ValueRowMarginRight { get; set; }
Property Value
Type Description
System.Double

ValueRowMarginTop

Declaration
public double ValueRowMarginTop { get; set; }
Property Value
Type Description
System.Double

ValueRowVisible

Gets or sets whether to show series rows.

Declaration
public bool ValueRowVisible { get; set; }
Property Value
Type Description
System.Boolean

ValueTextColor

Gets or sets the units text color.

Declaration
public string ValueTextColor { get; set; }
Property Value
Type Description
System.String

ValueTextFontFamily

Declaration
public string ValueTextFontFamily { get; set; }
Property Value
Type Description
System.String

ValueTextFontSize

Declaration
public double ValueTextFontSize { get; set; }
Property Value
Type Description
System.Double

ValueTextFontStyle

Declaration
public string ValueTextFontStyle { get; set; }
Property Value
Type Description
System.String

ValueTextFontWeight

Declaration
public string ValueTextFontWeight { get; set; }
Property Value
Type Description
System.String

ValueTextMarginBottom

Declaration
public double ValueTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

ValueTextMarginLeft

Declaration
public double ValueTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

ValueTextMarginRight

Declaration
public double ValueTextMarginRight { get; set; }
Property Value
Type Description
System.Double

ValueTextMarginTop

Declaration
public double ValueTextMarginTop { get; set; }
Property Value
Type Description
System.Double

ValueTextUseSeriesColors

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

Declaration
public bool ValueTextUseSeriesColors { get; set; }
Property Value
Type Description
System.Boolean

ValueTextWhenMissingData

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

Declaration
public string ValueTextWhenMissingData { get; set; }
Property Value
Type Description
System.String

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

ExportSerializedVisualData()

Declaration
public string ExportSerializedVisualData()
Returns
Type Description
System.String

ExportSerializedVisualDataAsync()

Returns the legend visuals expressed as a serialized string.

Declaration
public Task<string> ExportSerializedVisualDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

Flush()

Declaration
public void Flush()

FlushAsync()

Forces any pending refresh to the legend to be finished.

Declaration
public Task FlushAsync()
Returns
Type Description
System.Threading.Tasks.Task

GetAbbreviatedNumber(Double, DataAbbreviationMode, Int32, Int32)

Declaration
public double GetAbbreviatedNumber(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)
Parameters
Type Name Description
System.Double number
DataAbbreviationMode mode
System.Int32 minDigits
System.Int32 maxDigits
Returns
Type Description
System.Double

GetAbbreviatedNumberAsync(Double, DataAbbreviationMode, Int32, Int32)

Declaration
public Task<double> GetAbbreviatedNumberAsync(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)
Parameters
Type Name Description
System.Double number
DataAbbreviationMode mode
System.Int32 minDigits
System.Int32 maxDigits
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetAbbreviatedString(Double, DataAbbreviationMode, Int32, Int32)

Declaration
public string GetAbbreviatedString(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)
Parameters
Type Name Description
System.Double number
DataAbbreviationMode mode
System.Int32 minDigits
System.Int32 maxDigits
Returns
Type Description
System.String

GetAbbreviatedStringAsync(Double, DataAbbreviationMode, Int32, Int32)

Declaration
public Task<string> GetAbbreviatedStringAsync(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)
Parameters
Type Name Description
System.Double number
DataAbbreviationMode mode
System.Int32 minDigits
System.Int32 maxDigits
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetAbbreviatedSymbol(Double, DataAbbreviationMode, Int32, Int32)

Declaration
public string GetAbbreviatedSymbol(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)
Parameters
Type Name Description
System.Double number
DataAbbreviationMode mode
System.Int32 minDigits
System.Int32 maxDigits
Returns
Type Description
System.String

GetAbbreviatedSymbolAsync(Double, DataAbbreviationMode, Int32, Int32)

Declaration
public Task<string> GetAbbreviatedSymbolAsync(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)
Parameters
Type Name Description
System.Double number
DataAbbreviationMode mode
System.Int32 minDigits
System.Int32 maxDigits
Returns
Type Description
System.Threading.Tasks.Task<System.String>

NotifySizeChanged()

Declaration
public void NotifySizeChanged()

NotifySizeChangedAsync()

Notifies the legend about changes to size

Declaration
public Task NotifySizeChangedAsync()
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable