Interface IChartSeries

Specifies the common API that RadzenChart series must implement.

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public interface IChartSeries

Properties

Color

Gets the color.

Declaration

string Color { get; }

Property Value

Type	Description
string	The color.

CoordinateSystem

Series coordinate system

Declaration

CoordinateSystem CoordinateSystem { get; }

Property Value

Type	Description
CoordinateSystem

MarkerSize

Gets the size of the marker.

Declaration

double MarkerSize { get; }

Property Value

Type	Description
double	The size of the marker.

MarkerType

Gets the series marker type.

Declaration

MarkerType MarkerType { get; }

Property Value

Type	Description
MarkerType	The type of the marker.

Markers

Gets or sets the series marker configuration.

Declaration

RadzenMarkers Markers { get; set; }

Property Value

Type	Description
RadzenMarkers

Overlays

Series overlays

Declaration

IList<IChartSeriesOverlay> Overlays { get; }

Property Value

Type	Description
IList<IChartSeriesOverlay>

RenderingOrder

Gets or sets the rendering order.

Declaration

int RenderingOrder { get; set; }

Property Value

Type	Description
int	The rendering order.

ShowInLegend

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

Declaration

bool ShowInLegend { get; }

Property Value

Type	Description
bool	true if the series appears in the legend; otherwise, false.

Title

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

Declaration

string Title { get; set; }

Property Value

Type	Description
string	The title.

Visible

Gets a value indicating whether this IChartSeries is visible.

Declaration

bool Visible { get; }

Property Value

Type	Description
bool	true if visible; otherwise, false.

Methods

Contains(double, double, double)

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

Declaration

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
bool	true if the series contains the coordinates; otherwise, false.

DataAt(double, double)

Returns the data at the specified coordinates;

Declaration

(object, Point) DataAt(double x, double y)

Parameters

Type	Name	Description
double	x	The x.
double	y	The y.

Returns

Type	Description
(object, Point)

GetDataLabels(double, double)

Returns data chart position

Declaration

IEnumerable<ChartDataLabel> GetDataLabels(double offsetX, double offsetY)

Parameters

Type	Name	Description
double	offsetX
double	offsetY

Returns

Type	Description
IEnumerable<ChartDataLabel>

GetMean()

Returns series mean

Declaration

double GetMean()

Returns

Type	Description
double

GetMedian()

Returns series median

Declaration

double GetMedian()

Returns

Type	Description
double

GetMode()

Returns series mode

Declaration

double GetMode()

Returns

Type	Description
double

GetTitle()

Gets the title.

Declaration

string GetTitle()

Returns

Type	Description
string

GetTooltipPosition(object)

Get position of the series tooltip.

Declaration

Point GetTooltipPosition(object data)

Parameters

Type	Name	Description
object	data	The data.

Returns

Type	Description
Point	Position.

GetTrend()

Returns series trend

Declaration

(double a, double b) GetTrend()

Returns

Type	Description
(double a, double b)

InvokeClick(EventCallback<SeriesClickEventArgs>, object)

Invokes the click handler with the provided data item.

Declaration

Task InvokeClick(EventCallback<SeriesClickEventArgs> handler, object data)

Parameters

Type	Name	Description
EventCallback<SeriesClickEventArgs>	handler	The handler.
object	data	The data.

Returns

Type	Description
Task

MeasureLegend()

Measures the legend.

Declaration

double MeasureLegend()

Returns

Type	Description
double	System.Double.

Render(ScaleBase, ScaleBase)

Renders the series with the specified category and value scales.

Declaration

RenderFragment Render(ScaleBase categoryScale, ScaleBase valueScale)

Parameters

Type	Name	Description
ScaleBase	categoryScale	The category scale.
ScaleBase	valueScale	The value scale.

Returns

Type	Description
RenderFragment	RenderFragment.

RenderLegendItem()

Renders the legend item.

Declaration

RenderFragment RenderLegendItem()

Returns

Type	Description
RenderFragment	RenderFragment.

RenderOverlays(ScaleBase, ScaleBase)

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

Declaration

RenderFragment RenderOverlays(ScaleBase categoryScale, ScaleBase valueScale)

Parameters

Type	Name	Description
ScaleBase	categoryScale	The category scale.
ScaleBase	valueScale	The value scale.

Returns

Type	Description
RenderFragment	RenderFragment.

RenderSharedTooltipItem(object)

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

Declaration

RenderFragment RenderSharedTooltipItem(object category)

Parameters

Type	Name	Description
object	category

Returns

Type	Description
RenderFragment

RenderTooltip(object)

Renders the series tooltip.

Declaration

RenderFragment RenderTooltip(object data)

Parameters

Type	Name	Description
object	data	The data.

Returns

Type	Description
RenderFragment	RenderFragment.

TransformCategoryScale(ScaleBase)

Transforms a category scale to new one.

Declaration

ScaleBase TransformCategoryScale(ScaleBase scale)

Parameters

Type	Name	Description
ScaleBase	scale	The scale.

Returns

Type	Description
ScaleBase

TransformValueScale(ScaleBase)

Transforms a category scale to new one.

Declaration

ScaleBase TransformValueScale(ScaleBase scale)

Parameters

Type	Name	Description
ScaleBase	scale	The scale.

Returns

Type	Description
ScaleBase