Class IgbHorizontalRangeCategorySeries

Base class for ranged category series with a category X-axis and a numeric Y-axis.

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbMarkerSeries
IgbCategorySeries
IgbRangeCategorySeries
IgbHorizontalRangeCategorySeries
IgbRangeAreaSeries
IgbRangeColumnSeries
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbHorizontalRangeCategorySeries : IgbRangeCategorySeries, JsonSerializable, IDisposable

Constructors

IgbHorizontalRangeCategorySeries()

Declaration
public IgbHorizontalRangeCategorySeries()

Properties

HighMemberAsLegendLabel

Gets or sets the label displayed before series' High value in the Data Legend.

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

HighMemberAsLegendUnit

Gets or sets the unit displayed after series' High value in the Data Legend.

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

LowMemberAsLegendLabel

Gets or sets the label displayed before series' Low value in the Data Legend.

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

LowMemberAsLegendUnit

Gets or sets the unit displayed after series' Low value in the Data Legend.

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

Type

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

XAxis

Gets or sets the effective x-axis for the current CategorySeries object.

Declaration
public IgbCategoryAxisBase XAxis { get; set; }
Property Value
Type Description
IgbCategoryAxisBase

XAxisName

Gets or sets the name to use to resolve xAxis from markup.

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

XAxisScript

Provides a means of setting XAxis in the JavaScript environment.

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

YAxis

Gets or sets the effective y-axis for the current CategorySeries object.

Declaration
public IgbNumericYAxis YAxis { get; set; }
Property Value
Type Description
IgbNumericYAxis

YAxisName

Gets or sets the name to use to resolve yAxis from markup.

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

YAxisScript

Provides a means of setting YAxis in the JavaScript environment.

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

Methods

BindAxes(IgbAxis[])

Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
Type Name Description
IgbAxis[] Axes
Overrides

CanUseAsXAxis(Object)

Declaration
public bool CanUseAsXAxis(object axis)
Parameters
Type Name Description
System.Object axis
Returns
Type Description
System.Boolean

CanUseAsXAxisAsync(Object)

Determine if object can be used as XAxis

Declaration
public Task<bool> CanUseAsXAxisAsync(object axis)
Parameters
Type Name Description
System.Object axis

The object to check
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

CanUseAsYAxis(Object)

Declaration
public bool CanUseAsYAxis(object axis)
Parameters
Type Name Description
System.Object axis
Returns
Type Description
System.Boolean

CanUseAsYAxisAsync(Object)

Determine if object can be used as YAxis

Declaration
public Task<bool> CanUseAsYAxisAsync(object axis)
Parameters
Type Name Description
System.Object axis

The object to check
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

FindByName(String)

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

GetCategoryWidth()

Declaration
public override double GetCategoryWidth()
Returns
Type Description
System.Double
Overrides

GetCategoryWidthAsync()

Returns the width of the category grouping this series is in.

Declaration
public override Task<double> GetCategoryWidthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetNextOrExactIndex(Point, Boolean)

Declaration
public override int GetNextOrExactIndex(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Int32
Overrides

GetNextOrExactIndexAsync(Point, Boolean)

Declaration
public override Task<int> GetNextOrExactIndexAsync(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides

GetOffsetValue()

Declaration
public override double GetOffsetValue()
Returns
Type Description
System.Double
Overrides

GetOffsetValueAsync()

Returns the offset value for this series if grouped on a category axis.

Declaration
public override Task<double> GetOffsetValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetPreviousOrExactIndex(Point, Boolean)

Declaration
public override int GetPreviousOrExactIndex(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Int32
Overrides

GetPreviousOrExactIndexAsync(Point, Boolean)

Declaration
public override Task<int> GetPreviousOrExactIndexAsync(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides

GetSeriesHighValue(Point, Boolean, Boolean)

Declaration
public override double GetSeriesHighValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double
Overrides

GetSeriesHighValueAsync(Point, Boolean, Boolean)

Declaration
public override Task<double> GetSeriesHighValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetSeriesHighValuePosition(Point, Boolean, Boolean)

Declaration
public override Point GetSeriesHighValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point
Overrides

GetSeriesHighValuePositionAsync(Point, Boolean, Boolean)

Declaration
public override Task<Point> GetSeriesHighValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>
Overrides

GetSeriesLowValue(Point, Boolean, Boolean)

Declaration
public override double GetSeriesLowValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double
Overrides

GetSeriesLowValueAsync(Point, Boolean, Boolean)

Declaration
public override Task<double> GetSeriesLowValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetSeriesLowValuePosition(Point, Boolean, Boolean)

Declaration
public override Point GetSeriesLowValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point
Overrides

GetSeriesLowValuePositionAsync(Point, Boolean, Boolean)

Declaration
public override Task<Point> GetSeriesLowValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>
Overrides

GetSeriesValue(Point, Boolean, Boolean)

Declaration
public override double GetSeriesValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double
Overrides

GetSeriesValueAsync(Point, Boolean, Boolean)

Declaration
public override Task<double> GetSeriesValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetSeriesValuePosition(Point, Boolean, Boolean)

Declaration
public override Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point
Overrides

GetSeriesValuePositionAsync(Point, Boolean, Boolean)

Declaration
public override Task<Point> GetSeriesValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>
Overrides

Implements

System.IDisposable