Series<TModel, TVisual, TLabel>
Class

Assembly LiveChartsCore
Namespace LiveChartsCore
View source code on GitHub

Summary:
Defines a series in a Cartesian chart.

Type parameters:
TModel The type of the model.
TVisual The type of the visual.
TLabel The type of the label.
Inheritance:
Object =>
ChartElement =>
Series<TModel, TVisual, TLabel>
Implements:
IChartElement
ISeries
ISeries<TModel>
IInternalSeries
Derived:
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CorePieSeries<TModel, TVisual, TLabel, TMiniatureGeometry>
CorePolarLineSeries<TModel, TVisual, TLabel, TPathGeometry, TLineGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, BoxGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, CandlestickGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, RoundedRectangleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, ColoredRectangleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, CircleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CorePieSeries<TModel, DoughnutGeometry, LabelGeometry, CircleGeometry>
CorePieSeries<TModel, TVisual, LabelGeometry, CircleGeometry>
CorePieSeries<TModel, TVisual, TLabel, CircleGeometry>
CorePolarLineSeries<TModel, CircleGeometry, LabelGeometry, CubicBezierAreaGeometry, LineGeometry>
CorePolarLineSeries<TModel, TVisual, LabelGeometry, CubicBezierAreaGeometry, LineGeometry>
CorePolarLineSeries<TModel, TVisual, TLabel, CubicBezierAreaGeometry, LineGeometry>
CartesianSeries<TModel, RoundedRectangleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, CircleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, CircleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, RoundedRectangleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, RoundedRectangleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, CircleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>
CartesianSeries<TModel, CircleGeometry, LabelGeometry>
CartesianSeries<TModel, TVisual, LabelGeometry>
CartesianSeries<TModel, TVisual, TLabel>

Properties

SeriesProperties
Gets the properties of the series.
Type: SeriesProperties
Name
Gets or sets the name of the series, the name is normally used by IChartTooltip or IChartLegend, the default value is set automatically by the library.
Type: String
Values
Gets or sets the data set to draw in the chart.
Type: IReadOnlyCollection<TModel>
Pivot
Gets or sets the value where the direction of the axis changes, by default is 0.
Type: Double
Mapping
Gets or sets the mapping.
Type: Func<TModel, Int32, Coordinate>
GeometrySvg
Gets or sets the series geometry svg, this property requires the series visual to be an IVariableSvgPath instance.
Type: String
ZIndex
Gets or sets the z index position.
Type: Int32
DataLabelsFormatter
Gets or sets the data label formatter, this function will build the label when a point in this series is shown as data label.
Type: Func<ChartPoint<TModel, TVisual, TLabel>, String>
IsHoverable
Gets or sets a value indicating whether this instance will show up in tool tips when the pointer is over a point. default value is true.
Type: Boolean
IsVisibleAtLegend
Gets or sets a value indicating whether this instance will show up in legends. default value is true.
Type: Boolean
DataPadding
Gets or sets the data padding, the distance from the edge of the chart to where the series is drawn, both coordinates (X and Y) from 0 to 1, where 0 is nothing and 1 is the axis tick (the separation between every label).
Type: LvcPoint
AnimationsSpeed
Gets or sets the animations speed, if this property is null, the AnimationsSpeed property will be used.
Type: Nullable<TimeSpan>
EasingFunction
Gets or sets the easing function to animate the series, if this property is null, the EasingFunction property will be used.
Type: Func<Single, Single>
DataFactory
Gets the data factory.
Type: DataFactory<TModel>
MiniatureShapeSize
Gets or sets the size of the legend shape.
Type: Double
CanvasSchedule
Obsolete.
Type: Sketch
DataLabelsPaint
Gets or sets the data labels paint.
Type: Paint
DataLabelsSize
Gets or sets the size of the data labels.
Type: Double
DataLabelsRotation
Gets or sets the data labels rotation in degrees.
Type: Double
DataLabelsPadding
Gets or sets the data labels padding.
Type: Padding
DataLabelsMaxWidth
Gets or sets the max width of the data labels.
Type: Double
Tag
Gets or sets the object that contains data about the control.
Type: Object
IsVisible
Gets or sets a value indicating whether the element is visible.
Type: Boolean

Events

PointMeasured
Occurs when an instance of ChartPoint is measured.
Handler definition: Action<ChartPoint<TModel, TVisual, TLabel>>
PointCreated
Occurs when an instance of ChartPoint is created.
Handler definition: Action<ChartPoint<TModel, TVisual, TLabel>>
DataPointerDown
Occurs when the pointer goes down over a chart point(s).
Handler definition: ChartPointsHandler<TModel, TVisual, TLabel>
ChartPointPointerHover
Occurs when the pointer is over a chart point.
Handler definition: ChartPointHandler<TModel, TVisual, TLabel>
ChartPointPointerHoverLost
Occurs when the pointer left a chart point.
Handler definition: ChartPointHandler<TModel, TVisual, TLabel>
ChartPointPointerDown
Occurs when the pointer goes down over a chart point, if there are multiple points, the closest one will be selected.
Handler definition: ChartPointHandler<TModel, TVisual, TLabel>
PropertyChanged
Occurs when a property value changes.
Handler definition: PropertyChangedEventHandler

Methods

// Gets the stack group, normally used internally to handled the stacked series.
// Clears the visuals in the cache and re-starts animations.
// Gets the tool tip text for a give chart point.
ChartPoint point// The chart point.
)
// Gets the tool tip text for a give chart point.
ChartPoint point// The chart point.
)
// Gets the data label content for a given chart point.
ChartPoint point// The chart point.
)
// Removes the element from the UI.
Chart chart// The chart.
)
// Converts a chart to a strong-typed version of it.
ChartPoint point//
)
// Deletes the series from the user interface.
IChartView chart// *summary not found*
)
//
// Return the visual element shown in tooltips and legends, this is an old method and will be replaced by ChartPoint).
ChartPoint point, // The point.
Int32 zindex// The zindex.
)
// Returns a geometry that represents the series in a tooltip or legend.
ChartPoint point// The target point.
)
// Invalidates the IChartElement in the user interface.
Chart chart// The chart.
)
// Deletes the Paint instances that changed from the user interface.
IChartView chart// The chart.
)