ClassChartSeriesDescriptor
Specifies a chart series descriptor.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Syntax:
public class ChartSeriesDescriptor
Inheritance: objectChartSeriesDescriptor
Constructors
ChartSeriesDescriptor()
Declaration
public ChartSeriesDescriptor()
Properties
Aggregate
Specifies the preferred series aggregate.
Declaration
[JsonPropertyName("aggregate")]
public ChartSeriesAggregate? Aggregate { get; set; }
Property Value
AutoFit
If set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series.
Declaration
[JsonPropertyName("autoFit")]
public bool? AutoFit { get; set; }
Property Value
bool?
Axis
The name of the value axis to use.
Declaration
[JsonPropertyName("axis")]
public string Axis { get; set; }
Property Value
CategoryAxis
The name of the category axis to use for the series.The first axis will be used if no categoryAxis is specified.
Declaration
[JsonPropertyName("categoryAxis")]
public string CategoryAxis { get; set; }
Property Value
CategoryField
The data item field which contains the category name or date.
Declaration
[JsonPropertyName("categoryField")]
public string CategoryField { get; set; }
Property Value
CloseField
The data field containing the close value.
Declaration
[JsonPropertyName("closeField")]
public string CloseField { get; set; }
Property Value
Color
The series base color. The supported values are: CSS color string, including hex and rgb or function(point) - user-defined function that will be evaluated for each point. Returning undefined will assume the default series color..
Declaration
[JsonPropertyName("color")]
public string Color { get; set; }
Property Value
ColorField
The data item field which contains the series color.
Declaration
[JsonPropertyName("colorField")]
public string ColorField { get; set; }
Property Value
DashType
The dash type of line chart.The following dash types are supported: "dash" - a line consisting of dashes; "dashDot" - a line consisting of a repeating pattern of dash-dot; "dot" - a line consisting of dots; "longDash" - a line consisting of a repeating pattern of long-dash; "longDashDot" - a line consisting of a repeating pattern of long-dash-dot; "longDashDotDot" - a line consisting of a repeating pattern of long-dash-dot-dot or "solid" - a solid line.
Declaration
[JsonPropertyName("dashType")]
public DashType? DashType { get; set; }
Property Value
Data
The data of the series.
Declaration
[JsonPropertyName("data")]
public IEnumerable<object> Data { get; set; }
Property Value
DownColor
The series color when the open value is greater than the close value.
Declaration
[JsonPropertyName("downColor")]
public string DownColor { get; set; }
Property Value
DownColorField
The data field containing the color applied when the open value is greater than the close value.
Declaration
[JsonPropertyName("downColorField")]
public string DownColorField { get; set; }
Property Value
DrilldownField
The data field which contains the value to use to drill down into detailed data for the point.
Declaration
[JsonPropertyName("drilldownField")]
public string DrilldownField { get; set; }
Property Value
ExplodeField
The data item field which contains a boolean value indicating whether the sector is exploded.
Declaration
[JsonPropertyName("explodeField")]
public string ExplodeField { get; set; }
Property Value
Field
The data item field which contains the series value. The field name should be a valid Javascript identifier and should contain only alphanumeric characters (or "$" or "_"), and may not start with a digit.
Declaration
[JsonPropertyName("field")]
public string Field { get; set; }
Property Value
FromField
The data item field which contains the series from value.
Declaration
[JsonPropertyName("fromField")]
public string FromField { get; set; }
Property Value
Gap
The distance between categories expressed as a percentage of the bar width.See the related spacing setting.
Declaration
[JsonPropertyName("gap")]
public double? Gap { get; set; }
Property Value
HighField
The data field containing the high value.
Declaration
[JsonPropertyName("highField")]
public string HighField { get; set; }
Property Value
HoleSize
The radius of the donut hole in pixels.
Declaration
[JsonPropertyName("holeSize")]
public double? HoleSize { get; set; }
Property Value
LowField
The data field containing the low value.
Declaration
[JsonPropertyName("lowField")]
public string LowField { get; set; }
Property Value
Margin
The margin around each donut series (ring). A numeric value will set all margins.
Declaration
[JsonPropertyName("margin")]
public double? Margin { get; set; }
Property Value
MissingValues
Specifies the behavior for handling missing values in the series.
Declaration
[JsonPropertyName("missingValues")]
public ChartSeriesMissingValues? MissingValues { get; set; }
Property Value
Name
The name of the chart series which is visible in the legend.
Declaration
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
NegativeColor
The color to use for bar, column or waterfall series with negative values. Accepts a valid CSS color string, including hex and rgb.
Declaration
[JsonPropertyName("negativeColor")]
public string NegativeColor { get; set; }
Property Value
Opacity
The series opacity. By default the series are opaque.
Declaration
[JsonPropertyName("opacity")]
public double? Opacity { get; set; }
Property Value
OpenField
The data field containing the open value.
Declaration
[JsonPropertyName("openField")]
public string OpenField { get; set; }
Property Value
Padding
The padding around the chart (equal on all sides).
Declaration
[JsonPropertyName("padding")]
public double? Padding { get; set; }
Property Value
Size
The or radius of the chart donut series in pixels. If not set, the available space is split evenly between the series.
Declaration
[JsonPropertyName("size")]
public double? Size { get; set; }
Property Value
SizeField
The data field containing the bubble size value.
Declaration
[JsonPropertyName("sizeField")]
public string SizeField { get; set; }
Property Value
Spacing
The distance between series points within a category. Expressed as a percentage of the bar width.See the related gap setting.
Declaration
[JsonPropertyName("spacing")]
public double? Spacing { get; set; }
Property Value
StartAngle
The start angle (degrees) of the first donut or pie segment.Angles increase clockwise and zero is to the left. Negative values are acceptable.
Declaration
[Parameter]
[JsonPropertyName("startAngle")]
public double? StartAngle { get; set; }
Property Value
Style
Specifies the preferred rendering style.
Declaration
[JsonPropertyName("style")]
public ChartSeriesStyle? Style { get; set; }
Property Value
SummaryField
The data item field which contains the summary type for waterfall series. Summary columns are optional and can be one of two types: "runningTotal" - Displays the sum of all items since the last "runningTotal" point. or "total" - Displays the sum of all previous items..
Declaration
[JsonPropertyName("summaryField")]
public string SummaryField { get; set; }
Property Value
ToField
The data item field which contains the series to value.
Declaration
[JsonPropertyName("toField")]
public string ToField { get; set; }
Property Value
Type
The type of the series.
Declaration
[JsonPropertyName("type")]
public ChartSeriesType? Type { get; set; }
Property Value
Visible
Sets the visible property of a chart series.
Declaration
[JsonPropertyName("visible")]
public bool? Visible { get; set; }
Property Value
bool?
VisibleInLegend
A value indicating whether to show the point category name (for funnel, donut and pie series) or series name (for other available series types) in the legend.
Declaration
[JsonPropertyName("visibleInLegend")]
public bool? VisibleInLegend { get; set; }
Property Value
bool?
VisibleInLegendField
The data item field which indicates whether to show the point category name in the legend.
Declaration
[JsonPropertyName("visibleInLegendField")]
public string VisibleInLegendField { get; set; }
Property Value
Width
The line width.
Declaration
[JsonPropertyName("width")]
public double? Width { get; set; }
Property Value
XAxis
The name of the X axis to use.For polar series the xAxis range is expressed in degrees.
Declaration
[JsonPropertyName("xAxis")]
public string XAxis { get; set; }
Property Value
XField
The data item field containing the X value.
Declaration
[JsonPropertyName("xField")]
public string XField { get; set; }
Property Value
YAxis
The name of the Y axis to use.** Available for bubble, scatter, scatterLine and polar series. **.
Declaration
[JsonPropertyName("yAxis")]
public string YAxis { get; set; }
Property Value
YField
The data item field containing the Y value.
Declaration
[JsonPropertyName("yField")]
public string YField { get; set; }
Property Value
ZIndex
An optional Z-index that can be used to change the default stacking order of series.The series with the highest Z-index will be placed on top.Series with no Z-index will use the default stacking order based on series type. For example line series will be on top with bar and area following below.
Declaration
[JsonPropertyName("zIndex")]
public double? ZIndex { get; set; }
Property Value