ScatterSeries<TModel, TVisual, TLabel, TDrawingContext, TErrorGeometry>
Class

Assembly LiveChartsCore

Namespace LiveChartsCore

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.
TDrawingContext	The type of the drawing context.
TErrorGeometry	The type of the error geometry.

Inheritance:

Object =>

ChartElement<TDrawingContext> =>

Series<TModel, TVisual, TLabel, TDrawingContext> =>

ChartSeries<TModel, TVisual, TLabel, TDrawingContext> =>

CartesianSeries<TModel, TVisual, TLabel, TDrawingContext> =>

StrokeAndFillCartesianSeries<TModel, TVisual, TLabel, TDrawingContext> =>

ScatterSeries<TModel, TVisual, TLabel, TDrawingContext, TErrorGeometry>

Implements:

IChartElement<TDrawingContext>

ISeries

ISeries<TModel>

IInternalSeries

IChartSeries<TDrawingContext>

ICartesianSeries<TDrawingContext>

IScatterSeries<TDrawingContext>

IStrokedAndFilled<TDrawingContext>

IErrorSeries<TDrawingContext>

Derived:

ScatterSeries<TModel, CircleGeometry, LabelGeometry>

ScatterSeries<TModel, TVisual, LabelGeometry>

ScatterSeries<TModel, TVisual, TLabel>

Constructors

// Initializes a new instance of the ScatterSeries`5 class.

ScatterSeries<TModel, TVisual, TLabel, TDrawingContext, TErrorGeometry>()

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

ErrorPaint

Gets or sets the error paint.
Type: IPaint<TDrawingContext>

Stroke

Gets or sets the stroke.
Type: IPaint<TDrawingContext>

Fill

Gets or sets the fill.
Type: IPaint<TDrawingContext>

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 tool tip label formatter for the X axis, this function will build the label when a point in this series is shown inside a tool tip.
Type: Func<ChartPoint<TModel, TVisual, TLabel>, String>

YToolTipLabelFormatter

Gets or sets the tool tip label formatter for the Y axis, this function will build the label when a point in this series is shown inside a tool tip.
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

DataLabelsPaint

Gets or sets the data labels paint.
Type: IPaint<TDrawingContext>

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

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`1 or IChartLegend`1, the default value is set automatically by the library.
Type: String

Values

Gets or sets the values.
Type: IEnumerable<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: Action<TModel, ChartPoint>

GeometrySvg

Gets or sets the series geometry svg, this property requires the series visual to be an ISvgPath`1 instance.
Type: String

ZIndex

Gets or sets the z index position.
Type: Int32

TooltipLabelFormatter

Gets or sets the tool tip label formatter, this function will build the label when a point in this series is shown inside a tool tip.
Type: Func<ChartPoint<TModel, TVisual, TLabel>, String>

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>

IsVisible

Gets or sets a value indicating whether this instance is visible.
Type: Boolean

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, TDrawingContext>

WhenPointMeasured

Called when a point is measured.
Type: Action<ChartPoint<TModel, TVisual, TLabel>>

LegendShapeSize

Gets or sets the size of the legend shape.
Type: Double

MiniatureShapeSize

Gets or sets the size of the legend shape.
Type: Double

CanvasSchedule

Gets the paint schedule, normally handled internally to display tool tips and legends.
Type: Sketch<TDrawingContext>

Tag

Gets or sets the object that contains data about the control.
Type: Object

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>

DataPointerHover

Occurs when the pointer is over a chart point.
Handler definition: ChartPointHandler<TModel, TVisual, TLabel>

DataPointerHoverLost

Occurs when the pointer left a chart point.
Handler definition: ChartPointHandler<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>

VisibilityChanged

Occurs when the series IsVisible property changes.
Handler definition: Action<ISeries>

PropertyChanged

Occurs when a property value changes.
Handler definition: PropertyChangedEventHandler

Methods

// Invalidates the IChartElement`1 in the user interface.

Invalidate(

Chart<TDrawingContext> chart

// The chart.

)

// Invalidates the IChartElement`1 in the user interface.

GetBounds(

CartesianChart<TDrawingContext> chart,	// The chart.
ICartesianAxis secondaryAxis,	// summary not found
ICartesianAxis primaryAxis	// summary not found