CoreScatterSeries<TModel, TVisual, TLabel, TErrorGeometry>
Class

Assembly LiveChartsCore
Namespace LiveChartsCore
View source code on GitHub

Summary:
Defines a scatter series.

Type parameters:
TModel The type of the model.
TVisual The type of the visual.
TLabel The type of the label.
TErrorGeometry The type of the error geometry.
Inheritance:
Object =>
ChartElement =>
Series<TModel, TVisual, TLabel> =>
CartesianSeries<TModel, TVisual, TLabel> =>
StrokeAndFillCartesianSeries<TModel, TVisual, TLabel> =>
CoreScatterSeries<TModel, TVisual, TLabel, TErrorGeometry>
Implements:
IChartElement
ISeries
ISeries<TModel>
IInternalSeries
ICartesianSeries
IScatterSeries
IStrokedAndFilled
IErrorSeries
Derived:
ScatterSeries<TModel, CircleGeometry, LabelGeometry>
ScatterSeries<TModel, TVisual, LabelGeometry>
ScatterSeries<TModel, TVisual, TLabel>

Constructors

// Initializes a new instance of the CoreScatterSeries`4 class.
IReadOnlyCollection<TModel> values// The values.
)

Properties

MinGeometrySize
Gets or sets the minimum size of the geometry.
Type: Double
GeometrySize
Gets or sets the size of the geometry.
Type: Double
IsWeighted
Gets a value indicating whether the points in this series use weight.
Type: Boolean
ShowError
Gets or sets a value indicating whether to show the error mark, to set the color use the ErrorPaint property, the ErrorPaint property could be defined by the theme when not explicitly set. Default is false.
Type: Boolean
ErrorPaint
Gets or sets the error paint.
Type: Paint
StackGroup
Gets or sets and index for the stack group, if multiple weighed series share the same stack group, they will be stacked, defualt is null and means that it is not stacked.
Type: Nullable<Int32>
Stroke
Gets or sets the stroke.
Type: Paint
Fill
Gets or sets the fill.
Type: Paint
ScalesXAt
Gets or sets the axis index where the series is scaled in the X plane, the index must exist in the XAxes collection.
Type: Int32
ScalesYAt
Gets or sets the axis index where the series is scaled in the Y plane, the index must exist in the YAxes collection.
Type: Int32
DataLabelsPosition
Gets or sets the data labels position.
Type: DataLabelsPosition
DataLabelsTranslate
Gets or sets the data labels translate transform, the property is of type LvcPoint, where the X property is in normalized units (from 0 to 1), where 1 is the width of the label and the Y property is also in normalized units (from 0 to 1), where 1 is the height of the label.
Type: Nullable<LvcPoint>
XToolTipLabelFormatter
Gets or sets the tooltip label formatter in the X axis, the function receives a ChartPoint instance and must return a string.
Type: Func<ChartPoint<TModel, TVisual, TLabel>, String>
YToolTipLabelFormatter
Gets or sets the tooltip label formatter in the Y axis, the function receives a ChartPoint instance and must return a string.
Type: Func<ChartPoint<TModel, TVisual, TLabel>, String>
ClippingMode
Gets or sets the clipping mode, clipping restricts the series and labels for being drawn outside of the chart area (DrawMargin), default is XY, and means that anything outside the chart bounds will be ignored.
Type: ClipMode
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 values.
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 labels formatter, the function receives a ChartPoint instance and must return a string.
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 ActualAnimationsSpeed property will be used.
Type: Nullable<TimeSpan>
EasingFunction
Gets or sets the easing function to animate the series, if this property is null, the ActualEasingFunction 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
MiniatureStrokeThickness
Gets or sets the miniature stroke thickness.
Type: Double
ShowDataLabels
Indicates whether the data labels are visible, to set the color use the DataLabelsPaint property, the DataLabelsPaint property could be defined by the theme when not explicitly set. Default is false.
Type: Boolean
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
VisualStates
Gets the visual states, states define the look of chart points when they are in a certain state, for example the hover, active, or selected states.
Type: VisualStatesDictionary
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

// Invalidates the IChartElement in the user interface.
Chart chart// The chart.
)
// Gets the series bounds.
Chart chart, // The chart.
ICartesianAxis secondaryAxis, // The x.
ICartesianAxis primaryAxis// The y.
)
// Returns a geometry that represents the series in a tooltip or legend.
ChartPoint point// The target point.
)
// 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.
)
// Deletes the series from the user interface.
IChartView chart// *summary not found*
)
// Gets the stack group, normally used internally to handled the stacked series.
// Clears the visuals in the cache and re-starts animations.
// 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 Paint instances that changed from the user interface.
IChartView chart// The chart.
)