IChartSeries Interface

Specifies the common API that RadzenChart series must implement.

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public interface IChartSeries

Properties

ColorLink to this section

Gets the color.

Declaration
public string Color { get; }
Property Value
Type Description
stringGets the color.

CoordinateSystemLink to this section

Series coordinate system

Declaration
public CoordinateSystem CoordinateSystem { get; }
Property Value
Type Description
CoordinateSystemSeries coordinate system

MarkerSizeLink to this section

Gets the size of the marker.

Declaration
public double MarkerSize { get; }
Property Value
Type Description
doubleGets the size of the marker.

MarkerTypeLink to this section

Gets the series marker type.

Declaration
public MarkerType MarkerType { get; }
Property Value
Type Description
MarkerTypeGets the series marker type.

MarkersLink to this section

Gets or sets the series marker configuration.

Declaration
public RadzenMarkers Markers { get; set; }
Property Value
Type Description
RadzenMarkersGets or sets the series marker configuration.

OverlaysLink to this section

Series overlays

Declaration
public IList<IChartSeriesOverlay> Overlays { get; }
Property Value
Type Description
IList<IChartSeriesOverlay>Series overlays

RenderingOrderLink to this section

Gets or sets the rendering order.

Declaration
public int RenderingOrder { get; set; }
Property Value
Type Description
intGets or sets the rendering order.

ShowActivePointLink to this section

Specifies whether the chart highlights the hovered data point of this series with an active point dot. Range-style series (candlestick, OHLC, high-low, box plot) opt out - a single dot cannot represent their value range. The default is true.

Declaration
public bool ShowActivePoint { get; }
Property Value
Type Description
boolSpecifies whether the chart highlights the hovered data point of this series with an active point dot. Range-style series (candlestick, OHLC, high-low, box plot) opt out - a single dot cannot represent their value range. The default is true.

ShowInLegendLink to this section

Gets a value indicating whether this series should appear in the legend.

Declaration
public bool ShowInLegend { get; }
Property Value
Type Description
boolGets a value indicating whether this series should appear in the legend.

TitleLink to this section

Gets or sets the title of the series. The title is displayed in tooltips and the legend.

Declaration
public string Title { get; set; }
Property Value
Type Description
stringGets or sets the title of the series. The title is displayed in tooltips and the legend.

VisibleLink to this section

Gets a value indicating whether this IChartSeries is visible.

Declaration
public bool Visible { get; }
Property Value
Type Description
boolGets a value indicating whether this IChartSeries is visible.

Methods

ContainsLink to this section

Determines if the series contains the specified coordinates with a given tolerance.

Declaration
public abstract bool Contains(double x, double y, double tolerance)
Parameters
Type Name Description
double x The x.
double y The y.
double tolerance The tolerance.
Returns
Type Description
booltrue if the series contains the coordinates; otherwise, false.

DataAtLink to this section

Returns the data at the specified coordinates;

Declaration
public abstract ValueTuple<object, Point> DataAt(double x, double y)
Parameters
Type Name Description
double x The x.
double y The y.
Returns
Type Description
ValueTuple<object, Point>

GetDataLabelsLink to this section

Returns data chart position

Declaration
public abstract IEnumerable<Rendering.ChartDataLabel> GetDataLabels(double offsetX, double offsetY)
Parameters
Type Name Description
double offsetX
double offsetY
Returns
Type Description
IEnumerable<Rendering.ChartDataLabel>

GetDataLabelsLink to this section

Returns data chart position

Declaration
public virtual IEnumerable<Rendering.ChartDataLabel> GetDataLabels(double offsetX, double offsetY, DataLabelPosition position)
Parameters
Type Name Description
double offsetX
double offsetY
DataLabelPosition position
Returns
Type Description
IEnumerable<Rendering.ChartDataLabel>

GetMeanLink to this section

Returns series mean

Declaration
public abstract double GetMean()
Returns
Type Description
double

GetMedianLink to this section

Returns series median

Declaration
public abstract double GetMedian()
Returns
Type Description
double

GetModeLink to this section

Returns series mode

Declaration
public abstract double GetMode()
Returns
Type Description
double

GetScaledDataPointsLink to this section

Returns the series data as scaled (pixel) points ordered by category position.

Declaration
public abstract IList<Point> GetScaledDataPoints()
Returns
Type Description
IList<Point>

GetTitleLink to this section

Gets the title.

Declaration
public abstract string GetTitle()
Returns
Type Description
string

GetTooltipPositionLink to this section

Get position of the series tooltip.

Declaration
public abstract Point GetTooltipPosition(object data)
Parameters
Type Name Description
object data The data.
Returns
Type Description
PointPosition.

GetTrendLink to this section

Returns series trend

Declaration
public abstract ValueTuple<double, double> GetTrend()
Returns
Type Description
ValueTuple<double, double>

InvokeClickLink to this section

Invokes the click handler with the provided data item.

Declaration
public abstract Task InvokeClick(EventCallback<SeriesClickEventArgs> handler, object data)
Parameters
Type Name Description
EventCallback<SeriesClickEventArgs> handler The handler.
object data The data.
Returns
Type Description
Task

MeasureLegendLink to this section

Measures the legend.

Declaration
public abstract double MeasureLegend()
Returns
Type Description
doubleSystem.Double.

MeasureLegendItemsLink to this section

Measures the text width of each individual legend item the series contributes. Series that render a single legend item return one value; pie-like series return one value per data item. Used to estimate how many rows a top or bottom legend wraps into.

Declaration
public abstract IEnumerable<double> MeasureLegendItems()
Returns
Type Description
IEnumerable<double>The text width of each legend item.

RenderLink to this section

Renders the series with the specified category and value scales.

Declaration
public abstract RenderFragment Render(ScaleBase categoryScale, ScaleBase valueScale)
Parameters
Type Name Description
ScaleBase categoryScale The category scale.
ScaleBase valueScale The value scale.
Returns
Type Description
RenderFragmentRenderFragment.

RenderLegendItemLink to this section

Renders the legend item.

Declaration
public abstract RenderFragment RenderLegendItem()
Returns
Type Description
RenderFragmentRenderFragment.

RenderOverlaysLink to this section

Renders the series overlays with the specified category and value scales.

Declaration
public abstract RenderFragment RenderOverlays(ScaleBase categoryScale, ScaleBase valueScale)
Parameters
Type Name Description
ScaleBase categoryScale The category scale.
ScaleBase valueScale The value scale.
Returns
Type Description
RenderFragmentRenderFragment.

RenderSharedTooltipItemLink to this section

Renders a tooltip item with the specified data to be displayed in a shared tooltip

Declaration
public abstract RenderFragment RenderSharedTooltipItem(object category)
Parameters
Type Name Description
object category
Returns
Type Description
RenderFragment

RenderTooltipLink to this section

Renders the series tooltip.

Declaration
public abstract RenderFragment RenderTooltip(object data)
Parameters
Type Name Description
object data The data.
Returns
Type Description
RenderFragmentRenderFragment.

RenderTopOverlaysLink to this section

Renders the overlays which display above all series (see RenderOnTop), so later series cannot draw over them.

Declaration
public virtual RenderFragment RenderTopOverlays(ScaleBase categoryScale, ScaleBase valueScale)
Parameters
Type Name Description
ScaleBase categoryScale The category scale.
ScaleBase valueScale The value scale.
Returns
Type Description
RenderFragmentRenderFragment.

TransformCategoryScaleLink to this section

Transforms a category scale to new one.

Declaration
public abstract ScaleBase TransformCategoryScale(ScaleBase scale)
Parameters
Type Name Description
ScaleBase scale The scale.
Returns
Type Description
ScaleBase

TransformValueScaleLink to this section

Transforms a category scale to new one.

Declaration
public abstract ScaleBase TransformValueScale(ScaleBase scale)
Parameters
Type Name Description
ScaleBase scale The scale.
Returns
Type Description
ScaleBase
In This Article
An error has occurred. This app may no longer respond until reloaded. Reload 🗙