IgbDataLegend | Infragistics API Docs

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

Inheritance

object

ComponentBase

BaseRendererControl

IgbDataLegend

Implements

IComponent
IHandleEvent
IHandleAfterRender
JsonSerializable
IDisposable

Constructors

constructor

public IgbDataLegend()

Returns IgbDataLegend

Properties

IgBlazor

Inherited from: BaseRendererControl

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Height

Inherited from: BaseRendererControl

[Parameter]
public string Height { get; set; }

Width

Inherited from: BaseRendererControl

[Parameter]
public string Width { get; set; }

Class

Inherited from: BaseRendererControl

[Parameter]
public string Class { get; set; }

AdditionalAttributes

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

ParentTypeName

Inherited from: BaseRendererControl

protected virtual string ParentTypeName { get; }

EventBehavior

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

ChildContent

Inherited from: BaseRendererControl

[Parameter]
public RenderFragment ChildContent { get; set; }

RoundTripDateConversion

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }

SupportsVisualChildren

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

UseDirectRender

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

DirectRenderElementName

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

NeedsDynamicContent

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

UseCamelEnumValues

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }

ActualBackground

Gets the effective background of the data legend.

[Parameter]
public string ActualBackground { get; set; }

ActualBadgesVisible

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

[Parameter]
public bool ActualBadgesVisible { get; set; }

ActualBorderBrush

Gets the effective border brush of the data legend.

[Parameter]
public string ActualBorderBrush { get; set; }

ActualBorderThicknessBottom

[Parameter]
public double ActualBorderThicknessBottom { get; set; }

ActualBorderThicknessLeft

[Parameter]
public double ActualBorderThicknessLeft { get; set; }

ActualBorderThicknessRight

[Parameter]
public double ActualBorderThicknessRight { get; set; }

ActualBorderThicknessTop

[Parameter]
public double ActualBorderThicknessTop { get; set; }

ActualPixelScalingRatio

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

[Parameter]
public double ActualPixelScalingRatio { get; set; }

BadgeMarginBottom

[Parameter]
public double BadgeMarginBottom { get; set; }

BadgeMarginLeft

[Parameter]
public double BadgeMarginLeft { get; set; }

BadgeMarginRight

[Parameter]
public double BadgeMarginRight { get; set; }

BadgeMarginTop

[Parameter]
public double BadgeMarginTop { get; set; }

BadgeShape

Gets or sets the BadgeShape for the data legend.

[Parameter]
public LegendItemBadgeShape BadgeShape { get; set; }

ContentBackground

Gets or sets the background of the data legend.

[Parameter]
public string ContentBackground { get; set; }

ContentBorderBrush

Gets or sets the border color of the data legend.

[Parameter]
public string ContentBorderBrush { get; set; }

ContentBorderThickness

Gets or sets the border thickness of the data legend.

[Parameter]
public double ContentBorderThickness { get; set; }

DefaultEventBehavior

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

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"

[Parameter]
public string[] ExcludedColumns { get; set; }

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"

[Parameter]
public string[] ExcludedSeries { get; set; }

GroupRowMarginBottom

[Parameter]
public double GroupRowMarginBottom { get; set; }

GroupRowMarginLeft

[Parameter]
public double GroupRowMarginLeft { get; set; }

GroupRowMarginRight

[Parameter]
public double GroupRowMarginRight { get; set; }

GroupRowMarginTop

[Parameter]
public double GroupRowMarginTop { get; set; }

GroupRowVisible

Gets or sets whether to show Header row.

[Parameter]
public bool GroupRowVisible { get; set; }

GroupTextColor

Gets or sets the Group text color.

[Parameter]
public string GroupTextColor { get; set; }

GroupTextFontFamily

[Parameter]
public string GroupTextFontFamily { get; set; }

GroupTextFontSize

[Parameter]
public double GroupTextFontSize { get; set; }

GroupTextFontStyle

[Parameter]
public string GroupTextFontStyle { get; set; }

GroupTextFontWeight

[Parameter]
public string GroupTextFontWeight { get; set; }

GroupTextMarginBottom

[Parameter]
public double GroupTextMarginBottom { get; set; }

GroupTextMarginLeft

[Parameter]
public double GroupTextMarginLeft { get; set; }

GroupTextMarginRight

[Parameter]
public double GroupTextMarginRight { get; set; }

GroupTextMarginTop

[Parameter]
public double GroupTextMarginTop { get; set; }

HeaderFormatCulture

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

[Parameter]
public string HeaderFormatCulture { get; set; }

HeaderFormatDate

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

[Parameter]
public DataLegendHeaderDateMode HeaderFormatDate { get; set; }

HeaderFormatSpecifiers

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

public IgbFormatSpecifierCollection HeaderFormatSpecifiers { get; set; }

HeaderFormatString

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

[Parameter]
public string HeaderFormatString { get; set; }

HeaderFormatTime

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

[Parameter]
public DataLegendHeaderTimeMode HeaderFormatTime { get; set; }

HeaderRowMarginBottom

[Parameter]
public double HeaderRowMarginBottom { get; set; }

HeaderRowMarginLeft

[Parameter]
public double HeaderRowMarginLeft { get; set; }

HeaderRowMarginRight

[Parameter]
public double HeaderRowMarginRight { get; set; }

HeaderRowMarginTop

[Parameter]
public double HeaderRowMarginTop { get; set; }

HeaderRowVisible

Gets or sets whether to show Header row.

[Parameter]
public bool HeaderRowVisible { get; set; }

HeaderText

Gets or sets the HeaderText for the data legend.

[Parameter]
public string HeaderText { get; set; }

HeaderTextColor

Gets or sets the header text color.

[Parameter]
public string HeaderTextColor { get; set; }

HeaderTextFontFamily

[Parameter]
public string HeaderTextFontFamily { get; set; }

HeaderTextFontSize

[Parameter]
public double HeaderTextFontSize { get; set; }

HeaderTextFontStyle

[Parameter]
public string HeaderTextFontStyle { get; set; }

HeaderTextFontWeight

[Parameter]
public string HeaderTextFontWeight { get; set; }

HeaderTextMarginBottom

[Parameter]
public double HeaderTextMarginBottom { get; set; }

HeaderTextMarginLeft

[Parameter]
public double HeaderTextMarginLeft { get; set; }

HeaderTextMarginRight

[Parameter]
public double HeaderTextMarginRight { get; set; }

HeaderTextMarginTop

[Parameter]
public double HeaderTextMarginTop { get; set; }

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"

[Parameter]
public string[] IncludedColumns { get; set; }

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"

[Parameter]
public string[] IncludedSeries { get; set; }

IsEmbeddedInDataTooltip

Gets or sets whether the legend is embedded in a DataTooltip

[Parameter]
public bool IsEmbeddedInDataTooltip { get; set; }

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

[Parameter]
public DataLegendLabelMode LabelDisplayMode { get; set; }

LabelTextColor

Gets or sets the units text color.

[Parameter]
public string LabelTextColor { get; set; }

LabelTextFontFamily

[Parameter]
public string LabelTextFontFamily { get; set; }

LabelTextFontSize

[Parameter]
public double LabelTextFontSize { get; set; }

LabelTextFontStyle

[Parameter]
public string LabelTextFontStyle { get; set; }

LabelTextFontWeight

[Parameter]
public string LabelTextFontWeight { get; set; }

LabelTextMarginBottom

[Parameter]
public double LabelTextMarginBottom { get; set; }

LabelTextMarginLeft

[Parameter]
public double LabelTextMarginLeft { get; set; }

LabelTextMarginRight

[Parameter]
public double LabelTextMarginRight { get; set; }

LabelTextMarginTop

[Parameter]
public double LabelTextMarginTop { get; set; }

LayoutMode

Gets or sets the layout of content in the data legend

[Parameter]
public DataLegendLayoutMode LayoutMode { get; set; }

PixelScalingRatio

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

[Parameter]
public double PixelScalingRatio { get; set; }

ShouldUpdateWhenSeriesDataChanges

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

[Parameter]
public bool ShouldUpdateWhenSeriesDataChanges { get; set; }

SummaryLabelText

Gets or sets the units text for the data legend.

[Parameter]
public string SummaryLabelText { get; set; }

SummaryLabelTextColor

Gets or sets the units text color.

[Parameter]
public string SummaryLabelTextColor { get; set; }

SummaryLabelTextFontFamily

[Parameter]
public string SummaryLabelTextFontFamily { get; set; }

SummaryLabelTextFontSize

[Parameter]
public double SummaryLabelTextFontSize { get; set; }

SummaryLabelTextFontStyle

[Parameter]
public string SummaryLabelTextFontStyle { get; set; }

SummaryLabelTextFontWeight

[Parameter]
public string SummaryLabelTextFontWeight { get; set; }

SummaryRowMarginBottom

[Parameter]
public double SummaryRowMarginBottom { get; set; }

SummaryRowMarginLeft

[Parameter]
public double SummaryRowMarginLeft { get; set; }

SummaryRowMarginRight

[Parameter]
public double SummaryRowMarginRight { get; set; }

SummaryRowMarginTop

[Parameter]
public double SummaryRowMarginTop { get; set; }

SummaryTitleText

Gets or sets the SummaryTitleText for the data legend.

[Parameter]
public string SummaryTitleText { get; set; }

SummaryTitleTextColor

Gets or sets the summary text color.

[Parameter]
public string SummaryTitleTextColor { get; set; }

SummaryTitleTextFontFamily

[Parameter]
public string SummaryTitleTextFontFamily { get; set; }

SummaryTitleTextFontSize

[Parameter]
public double SummaryTitleTextFontSize { get; set; }

SummaryTitleTextFontStyle

[Parameter]
public string SummaryTitleTextFontStyle { get; set; }

SummaryTitleTextFontWeight

[Parameter]
public string SummaryTitleTextFontWeight { get; set; }

SummaryTitleTextMarginBottom

[Parameter]
public double SummaryTitleTextMarginBottom { get; set; }

SummaryTitleTextMarginLeft

[Parameter]
public double SummaryTitleTextMarginLeft { get; set; }

SummaryTitleTextMarginRight

[Parameter]
public double SummaryTitleTextMarginRight { get; set; }

SummaryTitleTextMarginTop

[Parameter]
public double SummaryTitleTextMarginTop { get; set; }

SummaryType

Gets or sets the SummaryType for the data legend.

[Parameter]
public DataLegendSummaryType SummaryType { get; set; }

SummaryUnitsText

Gets or sets the units text for the data legend.

[Parameter]
public string SummaryUnitsText { get; set; }

SummaryUnitsTextColor

Gets or sets the units text color.

[Parameter]
public string SummaryUnitsTextColor { get; set; }

SummaryUnitsTextFontFamily

[Parameter]
public string SummaryUnitsTextFontFamily { get; set; }

SummaryUnitsTextFontSize

[Parameter]
public double SummaryUnitsTextFontSize { get; set; }

SummaryUnitsTextFontStyle

[Parameter]
public string SummaryUnitsTextFontStyle { get; set; }

SummaryUnitsTextFontWeight

[Parameter]
public string SummaryUnitsTextFontWeight { get; set; }

SummaryValueTextColor

Gets or sets the units text color.

[Parameter]
public string SummaryValueTextColor { get; set; }

SummaryValueTextFontFamily

[Parameter]
public string SummaryValueTextFontFamily { get; set; }

SummaryValueTextFontSize

[Parameter]
public double SummaryValueTextFontSize { get; set; }

SummaryValueTextFontStyle

[Parameter]
public string SummaryValueTextFontStyle { get; set; }

SummaryValueTextFontWeight

[Parameter]
public string SummaryValueTextFontWeight { get; set; }

Target

Gets or sets the target for the data legend.

[Parameter]
public object Target { get; set; }

TargetCursorPositionX

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

[Parameter]
public double TargetCursorPositionX { get; set; }

TargetCursorPositionY

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

[Parameter]
public double TargetCursorPositionY { get; set; }

TargetScript

Provides a means of setting Target in the JavaScript environment.

[Parameter]
public string TargetScript { get; set; }

TitleTextColor

Gets or sets the display text color.

[Parameter]
public string TitleTextColor { get; set; }

TitleTextFontFamily

[Parameter]
public string TitleTextFontFamily { get; set; }

TitleTextFontSize

[Parameter]
public double TitleTextFontSize { get; set; }

TitleTextFontStyle

[Parameter]
public string TitleTextFontStyle { get; set; }

TitleTextFontWeight

[Parameter]
public string TitleTextFontWeight { get; set; }

TitleTextMarginBottom

[Parameter]
public double TitleTextMarginBottom { get; set; }

TitleTextMarginLeft

[Parameter]
public double TitleTextMarginLeft { get; set; }

TitleTextMarginRight

[Parameter]
public double TitleTextMarginRight { get; set; }

TitleTextMarginTop

[Parameter]
public double TitleTextMarginTop { get; set; }

Type

public override string Type { get; }

UnitsDisplayMode

Gets or sets the UnitsMode for the data legend.

[Parameter]
public DataLegendUnitsMode UnitsDisplayMode { get; set; }

UnitsText

Gets or sets the units text for the data legend.

[Parameter]
public string UnitsText { get; set; }

UnitsTextColor

Gets or sets the units text color.

[Parameter]
public string UnitsTextColor { get; set; }

UnitsTextFontFamily

[Parameter]
public string UnitsTextFontFamily { get; set; }

UnitsTextFontSize

[Parameter]
public double UnitsTextFontSize { get; set; }

UnitsTextFontStyle

[Parameter]
public string UnitsTextFontStyle { get; set; }

UnitsTextFontWeight

[Parameter]
public string UnitsTextFontWeight { get; set; }

UnitsTextMarginBottom

[Parameter]
public double UnitsTextMarginBottom { get; set; }

UnitsTextMarginLeft

[Parameter]
public double UnitsTextMarginLeft { get; set; }

UnitsTextMarginRight

[Parameter]
public double UnitsTextMarginRight { get; set; }

UnitsTextMarginTop

[Parameter]
public double UnitsTextMarginTop { get; set; }

ValueFormatAbbreviation

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

[Parameter]
public DataAbbreviationMode ValueFormatAbbreviation { get; set; }

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

[Parameter]
public string ValueFormatCulture { get; set; }

ValueFormatCurrencyCode

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

[Parameter]
public string ValueFormatCurrencyCode { get; set; }

ValueFormatMaxFractions

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

[Parameter]
public int ValueFormatMaxFractions { get; set; }

ValueFormatMinFractions

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

[Parameter]
public int ValueFormatMinFractions { get; set; }

ValueFormatMode

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

[Parameter]
public DataLegendValueMode ValueFormatMode { get; set; }

ValueFormatSpecifiers

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

public IgbFormatSpecifierCollection ValueFormatSpecifiers { get; set; }

ValueFormatString

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

[Parameter]
public string ValueFormatString { get; set; }

ValueFormatUseGrouping

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

[Parameter]
public bool ValueFormatUseGrouping { get; set; }

ValueRowMarginBottom

[Parameter]
public double ValueRowMarginBottom { get; set; }

ValueRowMarginLeft

[Parameter]
public double ValueRowMarginLeft { get; set; }

ValueRowMarginRight

[Parameter]
public double ValueRowMarginRight { get; set; }

ValueRowMarginTop

[Parameter]
public double ValueRowMarginTop { get; set; }

ValueRowVisible

Gets or sets whether to show series rows.

[Parameter]
public bool ValueRowVisible { get; set; }

ValueTextColor

Gets or sets the units text color.

[Parameter]
public string ValueTextColor { get; set; }

ValueTextFontFamily

[Parameter]
public string ValueTextFontFamily { get; set; }

ValueTextFontSize

[Parameter]
public double ValueTextFontSize { get; set; }

ValueTextFontStyle

[Parameter]
public string ValueTextFontStyle { get; set; }

ValueTextFontWeight

[Parameter]
public string ValueTextFontWeight { get; set; }

ValueTextMarginBottom

[Parameter]
public double ValueTextMarginBottom { get; set; }

ValueTextMarginLeft

[Parameter]
public double ValueTextMarginLeft { get; set; }

ValueTextMarginRight

[Parameter]
public double ValueTextMarginRight { get; set; }

ValueTextMarginTop

[Parameter]
public double ValueTextMarginTop { get; set; }

ValueTextUseSeriesColors

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

[Parameter]
public bool ValueTextUseSeriesColors { get; set; }

ValueTextWhenMissingData

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

[Parameter]
public string ValueTextWhenMissingData { get; set; }

Accessors

eventCallbacksCache

Inherited from: BaseRendererControl

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

_cachedSerializedContent

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Methods

ResolveEventBehavior()

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

ResolveDisplay()

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

ToSpinal(string)

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

value: string

Returns any

TransformSimpleKey(string)

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

key: string

Returns any

IsTransformedEnumValue(string)

Inherited from: BaseRendererControl

protected virtual bool IsTransformedEnumValue(string key)

Parameters

key: string

Returns any

TransformPotentialEnumValue(string, object)

Inherited from: BaseRendererControl

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

key: string
value: object

Returns any

BuildSequenceInfo(int)

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

startSequence: int

Returns any

BuildRenderTree(RenderTreeBuilder)

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

builder: RenderTreeBuilder

Returns any

TemplateContentType(string)

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

templateId: string

Returns any

OnAfterRenderAsync(bool)

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender: bool

Returns any

EnsureReady()

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

MarkPropDirty(string)

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

propertyName: string

Returns any

IsPropDirty(string)

Inherited from: BaseRendererControl

protected bool IsPropDirty(string propertyName)

Parameters

propertyName: string

Returns any

Serialize(SerializationContext, string)

Inherited from: BaseRendererControl

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

context: SerializationContext
propertyName: string

Returns any

Serialize()

Inherited from: BaseRendererControl

public string Serialize()

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Inherited from: BaseRendererControl

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

methodName: string
arguments: object[]
types: string[]
nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Inherited from: BaseRendererControl

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

methodName: string
arguments: object[]
types: string[]
nativeElements: ElementReference[]

Returns any

SuspendNotifications(object)

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

dataSource: object

Returns any

ResumeNotifications(object, bool)

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

dataSource: object
notify: bool

Returns any

NotifyInsertItem(object, int, object)

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

dataSource: object
index: int
refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

dataSource: object
index: int
oldItem: object

Returns any

NotifyClearItems(object)

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

dataSource: object
index: int
oldItem: object
newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Inherited from: BaseRendererControl

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

dataSource: object
index: int
refItem: object
syncDataOnly: bool

Returns any

OnRefChanged(string, object)

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

refName: string
refValue: object

Returns any

OnInvokeReturn(long, object)

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

invokeId: long
returnValue: object

Returns any

Camelize(string)

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

value: string

Returns any

ToPascal(string)

Inherited from: BaseRendererControl

protected string ToPascal(string value)

Parameters

value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Inherited from: BaseRendererControl

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

element: BaseRendererElement
oldName: string
newName: string

Returns any

Dispose(bool)

Inherited from: BaseRendererControl

protected virtual void Dispose(bool disposing)

Parameters

disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

grouping: string
id: string
value: string

Returns any

SetResourceStringAsync(string, string)

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

grouping: string
json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

item: object
property: PropertyInfo
jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

item: object
property: PropertyInfo
value: object

Returns any

Dispose()

Inherited from: BaseRendererControl

public void Dispose()

Returns any

EnsureModulesLoaded()

protected override void EnsureModulesLoaded()

Returns any

ExportSerializedVisualData()

public string ExportSerializedVisualData()

Returns any

ExportSerializedVisualDataAsync()

Returns the legend visuals expressed as a serialized string.

public Task<string> ExportSerializedVisualDataAsync()

Returns any

FindByName(string)

public override object FindByName(string name)

Parameters

name: string

Returns any

Flush()

public void Flush()

Returns any

FlushAsync()

Forces any pending refresh to the legend to be finished.

public Task FlushAsync()

Returns any

GetAbbreviatedNumber(double, DataAbbreviationMode, int, int)

public double GetAbbreviatedNumber(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)

Parameters

number: double
mode: DataAbbreviationMode
minDigits: int
maxDigits: int

Returns any

GetAbbreviatedNumberAsync(double, DataAbbreviationMode, int, int)

public Task<double> GetAbbreviatedNumberAsync(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)

Parameters

number: double
mode: DataAbbreviationMode
minDigits: int
maxDigits: int

Returns any

GetAbbreviatedString(double, DataAbbreviationMode, int, int)

public string GetAbbreviatedString(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)

Parameters

number: double
mode: DataAbbreviationMode
minDigits: int
maxDigits: int

Returns any

GetAbbreviatedStringAsync(double, DataAbbreviationMode, int, int)

public Task<string> GetAbbreviatedStringAsync(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)

Parameters

number: double
mode: DataAbbreviationMode
minDigits: int
maxDigits: int

Returns any

GetAbbreviatedSymbol(double, DataAbbreviationMode, int, int)

public string GetAbbreviatedSymbol(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)

Parameters

number: double
mode: DataAbbreviationMode
minDigits: int
maxDigits: int

Returns any

GetAbbreviatedSymbolAsync(double, DataAbbreviationMode, int, int)

public Task<string> GetAbbreviatedSymbolAsync(double number, DataAbbreviationMode mode, int minDigits, int maxDigits)

Parameters

number: double
mode: DataAbbreviationMode
minDigits: int
maxDigits: int

Returns any

NotifySizeChanged()

public void NotifySizeChanged()

Returns any

NotifySizeChangedAsync()

Notifies the legend about changes to size

public Task NotifySizeChangedAsync()

Returns any

Events

CalculateColumnSummary

[Parameter]
public EventCallback<IgbDataLegendSummaryEventArgs> CalculateColumnSummary { get; set; }

StyleGroupRow

[Parameter]
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleGroupRow { get; set; }

StyleHeaderRow

[Parameter]
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleHeaderRow { get; set; }

StyleSeriesColumn

[Parameter]
public EventCallback<IgbDataLegendStylingColumnEventArgs> StyleSeriesColumn { get; set; }

StyleSeriesRow

[Parameter]
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleSeriesRow { get; set; }

StyleSummaryColumn

[Parameter]
public EventCallback<IgbDataLegendStylingColumnEventArgs> StyleSummaryColumn { get; set; }

StyleSummaryRow

[Parameter]
public EventCallback<IgbDataLegendStylingRowEventArgs> StyleSummaryRow { get; set; }

CalculateColumnSummaryScript

[Parameter]
public string CalculateColumnSummaryScript { get; set; }

StyleGroupRowScript

[Parameter]
public string StyleGroupRowScript { get; set; }

StyleHeaderRowScript

[Parameter]
public string StyleHeaderRowScript { get; set; }

StyleSeriesColumnScript

[Parameter]
public string StyleSeriesColumnScript { get; set; }

StyleSeriesRowScript

[Parameter]
public string StyleSeriesRowScript { get; set; }

StyleSummaryColumnScript

[Parameter]
public string StyleSummaryColumnScript { get; set; }

StyleSummaryRowScript

[Parameter]
public string StyleSummaryRowScript { get; set; }