Class IgbCategoryChart

Represents a chart with an ordinal X-axis and a numeric Y-axis.

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

Constructors

IgbCategoryChart()

Declaration
public IgbCategoryChart()

Properties

AutoExpandMarginExtraPadding

Gets or sets the extra amount the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

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

AutoExpandMarginMaximumValue

Gets or sets the maximum amount the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

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

AutoMarginAndAngleUpdateMode

Gets or sets a whether the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

Declaration
public AutoMarginsAndAngleUpdateMode AutoMarginAndAngleUpdateMode { get; set; }
Property Value
Type Description
AutoMarginsAndAngleUpdateMode

ChartType

Gets or sets the type of chart series to generate from the data.

Declaration
public CategoryChartType ChartType { get; set; }
Property Value
Type Description
CategoryChartType

IsCategoryHighlightingEnabled

Gets or sets whether the category should be highlighted when hovered

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

IsItemHighlightingEnabled

Gets or sets whether the item should be highlighted when hovered

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

IsSplineShapePartOfRange

Gets or sets whether to include the spline shape in the axis range requested of the axis for spline type series.

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

IsTransitionInEnabled

Gets or sets whether animation of series plots is enabled when the chart is loading into view

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

MarkerCollisionAvoidance

Gets or sets the behavior for markers in each series which are placed too close together for the current view, resulting in a collision.

Declaration
public CategorySeriesMarkerCollisionAvoidance MarkerCollisionAvoidance { get; set; }
Property Value
Type Description
CategorySeriesMarkerCollisionAvoidance

NeedsDynamicContent

Declaration
protected override bool NeedsDynamicContent { get; }
Property Value
Type Description
System.Boolean
Overrides

NegativeBrushes

Gets or sets the palette used for coloring negative items of Waterfall chart type.

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

NegativeOutlines

Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall.

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

ShouldAutoExpandMarginForInitialLabels

Gets or sets a whether the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

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

ShouldConsiderAutoRotationForInitialLabels

Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true.

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

TooltipTemplate

Declaration
public RenderFragment<IgbDataContext> TooltipTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbDataContext>

TransitionInDuration

Gets or sets the duration used for animating series plots when the chart is loading into view

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

TransitionInEasingFunction

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

TransitionInEasingFunctionScript

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

TransitionInMode

Gets or sets the method that determines how to animate series plots when the chart is loading into view

Declaration
public CategoryTransitionInMode TransitionInMode { get; set; }
Property Value
Type Description
CategoryTransitionInMode

TransitionInSpeedType

Gets or sets the arrival speed used for animating series plots when the chart is loading into view

Declaration
public TransitionInSpeedType TransitionInSpeedType { get; set; }
Property Value
Type Description
TransitionInSpeedType

TransitionOutDuration

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

TransitionOutEasingFunction

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

TransitionOutEasingFunctionScript

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

Type

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

XAxisEnhancedIntervalPreferMoreCategoryLabels

Gets or sets whether the x axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

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

XAxisGap

Gets or sets the amount of space between adjacent categories for the X-axis.

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

The gap is silently clamped to the range [0, 1] when used.

XAxisInterval

Gets or sets the frequency of displayed labels along the X-axis.

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

Gets or sets the set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

XAxisMaximumGap

Gets or sets the maximum gap value to allow. This defaults to 1.0.

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

XAxisMinimumGapSize

Gets or sets the minimum amount of pixels to use for the gap between categories, if possible.

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

XAxisMinorInterval

Gets or sets the frequency of displayed minor lines along the X-axis.

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

Gets or sets the set value is a factor that determines how the minor lines will be displayed.

XAxisOverlap

Gets or sets the amount of overlap between adjacent categories for the X-axis.

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

Gets or sets the overlap is silently clamped to the range [-1, 1] when used.

XAxisZoomMaximumCategoryRange

Gets or sets number of visible categories at maximum zooming level

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

This property is overridden by chart's WindowRectMinWidth property

XAxisZoomMaximumItemSpan

Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value.

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

This property is overridden by chart's WindowRectMinWidth property

XAxisZoomToCategoryRange

Gets or sets number of categories that the chart will zoom in and fill plot area

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

This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

XAxisZoomToCategoryStart

Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items

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

This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

XAxisZoomToItemSpan

Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automaticlly zoom in until series item has specified pixel span.

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

This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

YAxisAbbreviateLargeNumbers

Gets or sets whether the large numbers on the Y-axis labels are abbreviated.

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

YAxisAutoRangeBufferMode

Gets or sets how the numeric axis will adjust its range buffer to less closely fix the data from the series.

Declaration
public AxisRangeBufferMode YAxisAutoRangeBufferMode { get; set; }
Property Value
Type Description
AxisRangeBufferMode

YAxisEnhancedIntervalPreferMoreCategoryLabels

Gets or sets whether the y axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

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

YAxisFavorLabellingScaleEnd

Gets or sets whether the axis should favor emitting a label at the end of the scale.

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

YAxisInterval

Gets or sets the distance between each label and grid line along the Y-axis.

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

YAxisIsLogarithmic

Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one.

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

Since log(-1) is imaginary and log(0) is undefined, it is recommended to enable this property only when the Y-axis minimum is greater than zero.

YAxisLogarithmBase

Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis.

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

This property is effective only when YAxisIsLogarithmic is true.

YAxisMaximumValue

Gets or sets the data value corresponding to the maximum value of the Y-axis.

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

YAxisMinimumValue

Gets or sets the data value corresponding to the minimum value of the Y-axis.

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

YAxisMinorInterval

Gets or sets the frequency of displayed minor lines along the Y-axis.

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

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

ExportSerializedVisualData()

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

ExportSerializedVisualDataAsync()

Export serialized visual data.

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

GetCurrentXAxisActualMaximum()

Declaration
public double GetCurrentXAxisActualMaximum()
Returns
Type Description
System.Double

GetCurrentXAxisActualMaximumAsync()

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

GetCurrentXAxisActualMinimum()

Declaration
public double GetCurrentXAxisActualMinimum()
Returns
Type Description
System.Double

GetCurrentXAxisActualMinimumAsync()

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

GetCurrentYAxisActualMaximum()

Declaration
public double GetCurrentYAxisActualMaximum()
Returns
Type Description
System.Double

GetCurrentYAxisActualMaximumAsync()

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

GetCurrentYAxisActualMinimum()

Declaration
public double GetCurrentYAxisActualMinimum()
Returns
Type Description
System.Double

GetCurrentYAxisActualMinimumAsync()

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

RecalculateMarginAutoExpansion()

Declaration
public void RecalculateMarginAutoExpansion()

RecalculateMarginAutoExpansionAsync()

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

Implements

System.IDisposable