IChartSeries Interface

Specifies the common API that RadzenChart series must implement.

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public interface IChartSeries

Properties

Colorlink

Gets the color.

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

CoordinateSystemlink

Series coordinate system

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

MarkerSizelink

Gets the size of the marker.

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

MarkerTypelink

Gets the series marker type.

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

Markerslink

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

Series overlays

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

RenderingOrderlink

Gets or sets the rendering order.

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

ShowInLegendlink

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

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

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

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

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

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>

GetMeanlink

Returns series mean

Declaration
public abstract double GetMean()
Returns
Type Description
double

GetMedianlink

Returns series median

Declaration
public abstract double GetMedian()
Returns
Type Description
double

GetModelink

Returns series mode

Declaration
public abstract double GetMode()
Returns
Type Description
double

GetTitlelink

Gets the title.

Declaration
public abstract string GetTitle()
Returns
Type Description
string

GetTooltipPositionlink

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

Returns series trend

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

InvokeClicklink

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

Measures the legend.

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

Renderlink

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

Renders the legend item.

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

RenderOverlayslink

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

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

Renders the series tooltip.

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

TransformCategoryScalelink

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

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 🗙