ChartCanvasSerie

Namespace: PP.Ui;

Inheritance hierarchy

Object

ChartCanvasSerie

Description

The ChartCanvasSerie class is used to work with a chart data series.

Syntax

PP.initClass(PP.Ui.ChartCanvasSerie, PP.Object, "PP.Ui.ChartCanvasSerie");

Constructor

	Constructor name	Brief description
	ChartCanvasSerie	The ChartCanvasSerie constructor creates an instance of the ChartCanvasSerie class.

Properties

	Property name	Brief description
	ApproximationPixelCoef	The ApproximationPixelCoef property determines smoothing coefficient.
	BorderPenEnabled	The BorderPenEnabled property determines whether elements that correspond to chart data series points have visible border.
	Center	The Center property determines coordinates of series center.
	ChildSeries	The ChildSeries property determines the collection of child series.
	Color	The Color property determines fill color of chart data series.
	CustomData	The CustomData property is used to store any custom data.
	Data	The Data property determines an array of chart series data.
	DataIndex	The DataIndex property determines index of a chart data series.
	DataLabels	The DataLabels property determines settings of data labels for chart data series points.
	DrawContext	The DrawContext property determines a rendering context for a chart data series.
	Editable	The Editable property determines whether chart data series points can be edited.
	EmptyLine	The EmptyLine property determines an object with settings of the line that connects thinned data.
	Highlighted	The Highlighted property determines whether a chart data series is highlighted.
	Index	The Index property determines a chart data series index.
	InsetColor	The InsetColor property determines color of pressed line.
	InsetLineWidth	The InsetLineWidth property determines width of pressed line color.
	IsEditingNow	The IsEditingNow property determines whether a chart data series is being edited.
	IsMasterSerie	The IsMasterSerie property determines whether a chart data series is a forecasting one.
	IsNewborn	The IsNewborn property determines whether a new series appears with animation.
	IsSelected	The IsSelected property determines whether a chart data series is selected.
	IsVisible	The IsVisible property determines whether a chart data series is visible.
	LegendIndex	The LegendText property determines a legend series index.
	LegendText	The LegendText property determines a legend element label.
	LegendTextWidth	The LegendTextWidth property determines available length of chart legend elements.
	LineBreak	The LineBreak property determines line break coefficient.
	LineColor	The LineColor property determines chart data series line color.
	LineDashStyle	The LineDashStyle property determines series line drawing style.
	LinePenEnabled	The LinePenEnabled property determines whether lines connecting chart data series points are shown.
	LineWidth	The LineWidth property determines chart data series line width.
	MarkedForDeath	The MarkedForDeath property determines whether a series is deleted with animation.
	Marker	The Marker property determines chart data series markers.
	MasterSerieIdx	The MasterSerieIdx property determines forecasting series index.
	Name	The Name property determines chart data series name.
	Parent	The Parent property determines a chart, to which a data series belongs.
	ParentSerieIndex	The ParentSerieIndex property determines parent series index.
	ReversedIndex	The ReversedIndex property determines reversed series index.
	Scatter	The Scatter property determines whether a series belongs to scatter type.
	SecondaryAxis	The SecondaryAxis property determines whether a secondary axis is used for a chart data series.
	SerieGroupName	The SerieGroupName property determines name of a series group.
	Shadow	The Shadow property determines an object with series shadow settings.
	ShowInLegend	The ShowInLegend property determines whether a data series is displayed in the chart legend.
	StackId	The StackId property determines chart stack index.
	StartAngle	The StartAngle property determines the start of drawing series angle.
	State	The State property determines whether the mouse cursor hovers on a chart data series.
	States	The States property determines settings of chart data series in JSON format.
	Threshold	The Threshold property determines the value that is the start point of reference of the Y axis.
	Trend	The Trend property determines whether a chart data series is a trend line.
	TrendLine	The TrendLine property contains trend line settings.
	Type	The Type property determines data series type.

Methods

	Method name	Brief description
	addPoint	The addPoint method adds a point to a chart data series.
	checkMouseCoords	The checkMouseCoords method checks if any point from the chart data series corresponds to the specified coordinates.
	checkPointOnPlot	The checkPointOnPlot method checks if a data series point is in the chart rendering area.
	drawDataLabels	The drawDataLabels method renders data labels for a chart data series.
	getPoint	The getPoint method returns a chart data series point by its index.
	getPointByPosition	The getPointByPosition method returns a chart data series element by its position on the X axis.
	getPoints	The getPoints method returns an array of data series elements.
	getXAxis	The getXAxis method returns chart data series category axis.
	getXData	The getXData method returns an array of chart data series elements values by the X axis.
	getYAxis	The getYAxis method returns chart data series value axis.
	getYData	The getYData method returns an array of chart data series elements values by the Y axis.
	redraw	The redraw method rerenders a chart data series.
	redrawConnectors	The redrawConnectors method rerenders points connected with fictive points of a forecasting series.
	redrawHoverPoint	The redrawHoverPoint method rerenders chart data series points.
	removePoint	The removePoint method removes a point from a chart data series.

Events

	Event name	Brief description
	Click	The Click event occurs on clicking a chart data series.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of a chart data series.
	PointAdd	The PointAdd event occurs after adding a point to a chart data series.
	RemovePoint	The RemovePoint event occurs after removing a point from chart data series.

Properties inherited from the class Object

	Property name	Brief description
	Id	The Id property determines a repository object identifier.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates an object copy.
	dispose	The dispose method deletes the component.
	getHashCode	The getHashCode method returns hash code of repository object.
	getId	The getId method returns repository object identifier.
	getSettings	The getSettings method returns repository object settings.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.
	isEqual	The isEqual method determines whether the specified object is equal to the current repository object.
	isLive	The isLive method determines validity of repository object.
	removeAllEvents	The removeAllEvents method removes all object event handlers by the specified context.
	setId	The setId method determines a repository object identifier.
	setSettings	The setSettings method determines repository object settings.
	defineProps	The defineProps method creates get and set methods from name array for the specified class.
	keys	The keys method returns array of methods and properties names for the specified object.

See also:

Chart

Copy page URL

Back to top

To report a found bug, please, select the text with the bug and click Report a Bug or CTRL+ENTER.

Help system 10.5 of 04/10/2024, © FORESIGHT