Interface IChartSeries

Namespace

Radzen.Blazor

Assembly

Radzen.Blazor.dll

Specifies the common API that RadzenChart series must implement.

public interface IChartSeries

Properties

Color

Gets the color.

string Color { get; }

Property Value

string

The color.

CoordinateSystem

Series coordinate system

CoordinateSystem CoordinateSystem { get; }

Property Value

CoordinateSystem

MarkerSize

Gets the size of the marker.

double MarkerSize { get; }

Property Value

double

The size of the marker.

MarkerType

Gets the series marker type.

MarkerType MarkerType { get; }

Property Value

MarkerType

The type of the marker.

Markers

Gets or sets the series marker configuration.

RadzenMarkers Markers { get; set; }

Property Value

RadzenMarkers

Overlays

Series overlays

IList<IChartSeriesOverlay> Overlays { get; }

Property Value

IList<IChartSeriesOverlay>

RenderingOrder

Gets or sets the rendering order.

int RenderingOrder { get; set; }

Property Value

int

The rendering order.

ShowInLegend

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

bool ShowInLegend { get; }

Property Value

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.

string Title { get; set; }

Property Value

string

The title.

Visible

Gets a value indicating whether this IChartSeries is visible.

bool Visible { get; }

Property Value

bool

true if visible; otherwise, false.

Methods

Contains(double, double, double)

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

bool Contains(double x, double y, double tolerance)

Parameters

x double

The x.

y double

The y.

tolerance double

The tolerance.

Returns

bool

true if the series contains the coordinates; otherwise, false.

DataAt(double, double)

Returns the data at the specified coordinates;

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

Parameters

x double

The x.

y double

The y.

Returns

(object, Point)

GetDataLabels(double, double)

Returns data chart position

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

Parameters

offsetX double

offsetY double

Returns

IEnumerable<ChartDataLabel>

GetMean()

Returns series mean

double GetMean()

Returns

double

GetMedian()

Returns series median

double GetMedian()

Returns

double

GetMode()

Returns series mode

double GetMode()

Returns

double

GetTitle()

Gets the title.

string GetTitle()

Returns

string

GetTrend()

Returns series trend

(double a, double b) GetTrend()

Returns

(double a, double b)

InvokeClick(EventCallback<SeriesClickEventArgs>, object)

Invokes the click handler with the provided data item.

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

Parameters

handler EventCallback<SeriesClickEventArgs>

The handler.

data object

The data.

Returns

Task

MeasureLegend()

Measures the legend.

double MeasureLegend()

Returns

double

System.Double.

Render(ScaleBase, ScaleBase)

Renders the series with the specified category and value scales.

RenderFragment Render(ScaleBase categoryScale, ScaleBase valueScale)

Parameters

categoryScale ScaleBase

The category scale.

valueScale ScaleBase

The value scale.

Returns

RenderFragment

RenderFragment.

RenderLegendItem()

Renders the legend item.

RenderFragment RenderLegendItem()

Returns

RenderFragment

RenderFragment.

RenderOverlays(ScaleBase, ScaleBase)

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

RenderFragment RenderOverlays(ScaleBase categoryScale, ScaleBase valueScale)

Parameters

categoryScale ScaleBase

The category scale.

valueScale ScaleBase

The value scale.

Returns

RenderFragment

RenderFragment.

RenderTooltip(object, double, double, double)

Renders the series tooltip.

RenderFragment RenderTooltip(object data, double marginLeft, double marginTop, double chartHeight)

Parameters

data object

The data.

marginLeft double

The left margin.

marginTop double

The right margin.

chartHeight double

Height of the whole char area.

Returns

RenderFragment

RenderFragment.

TransformCategoryScale(ScaleBase)

Transforms a category scale to new one.

ScaleBase TransformCategoryScale(ScaleBase scale)

Parameters

scale ScaleBase

The scale.

Returns

ScaleBase

TransformValueScale(ScaleBase)

Transforms a category scale to new one.

ScaleBase TransformValueScale(ScaleBase scale)

Parameters

scale ScaleBase

The scale.

Returns

ScaleBase