Class IgbDataLegendSeriesContext

Represent info about series values

Inheritance
System.Object
BaseRendererElement
IgbDataLegendSeriesContext
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataLegendSeriesContext : BaseRendererElement, JsonSerializable

Constructors

IgbDataLegendSeriesContext()

Declaration
public IgbDataLegendSeriesContext()

Properties

SeriesFamily

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

Type

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

Methods

FindByName(String)

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

GetSeriesValue(DataLegendSeriesValueType)

Declaration
public double GetSeriesValue(DataLegendSeriesValueType type)
Parameters
Type Name Description
DataLegendSeriesValueType type
Returns
Type Description
System.Double

GetSeriesValueAsync(DataLegendSeriesValueType)

Gets value info for the series value type

Declaration
public Task<double> GetSeriesValueAsync(DataLegendSeriesValueType type)
Parameters
Type Name Description
DataLegendSeriesValueType type
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetSeriesValueInfo(DataLegendSeriesValueType)

Declaration
public IgbDataLegendSeriesValueInfo GetSeriesValueInfo(DataLegendSeriesValueType type)
Parameters
Type Name Description
DataLegendSeriesValueType type
Returns
Type Description
IgbDataLegendSeriesValueInfo

GetSeriesValueInfoAsync(DataLegendSeriesValueType)

Creates an instance of DataLegendSeriesContext

Declaration
public Task<IgbDataLegendSeriesValueInfo> GetSeriesValueInfoAsync(DataLegendSeriesValueType type)
Parameters
Type Name Description
DataLegendSeriesValueType type
Returns
Type Description
System.Threading.Tasks.Task<IgbDataLegendSeriesValueInfo>

GetSeriesValues()

Declaration
public double[] GetSeriesValues()
Returns
Type Description
System.Double[]

GetSeriesValuesAsync()

Gets all values that a series renders at the current data point

Declaration
public Task<double[]> GetSeriesValuesAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double[]>
Remarks

For example, Open, High, Low, Close for Financial Series

SetSeriesValue(DataLegendSeriesValueType, Double)

Declaration
public void SetSeriesValue(DataLegendSeriesValueType type, double value)
Parameters
Type Name Description
DataLegendSeriesValueType type
System.Double value

SetSeriesValueAsync(DataLegendSeriesValueType, Double)

Declaration
public Task SetSeriesValueAsync(DataLegendSeriesValueType type, double value)
Parameters
Type Name Description
DataLegendSeriesValueType type
System.Double value
Returns
Type Description
System.Threading.Tasks.Task

SetSeriesValueInfo(DataLegendSeriesValueType, IgbDataLegendSeriesValueInfo)

Declaration
public void SetSeriesValueInfo(DataLegendSeriesValueType type, IgbDataLegendSeriesValueInfo valueInfo)
Parameters
Type Name Description
DataLegendSeriesValueType type
IgbDataLegendSeriesValueInfo valueInfo

SetSeriesValueInfoAsync(DataLegendSeriesValueType, IgbDataLegendSeriesValueInfo)

Declaration
public Task SetSeriesValueInfoAsync(DataLegendSeriesValueType type, IgbDataLegendSeriesValueInfo valueInfo)
Parameters
Type Name Description
DataLegendSeriesValueType type
IgbDataLegendSeriesValueInfo valueInfo
Returns
Type Description
System.Threading.Tasks.Task

Implements