Chart

Namespace: PP.Ui;

Inheritance hierarchy

Object

Control

Chart

Description

The Chart class is used to work with charts based on the Canvas element.

Syntax

PP.initClass(PP.Ui.Chart, PP.Ui.Control, "PP.Ui.Chart", [PP.Ui.IDVSynchronizable]);

Constructor

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

Properties

  Property name Brief description
Center The Center property determines chart center.
CustomData The CustomData property determines custom data.
Draggable The Draggable property determines whether a chart can be dragged.
EditMode The EditMode property determines an object that is used to edit a chart.
ExcludeInvisibleSeries The ExcludeInvisibleSeries property determines whether chart invisible data series must be excluded from calculation.
Inverted The Inverted property determines whether a chart is inverted.
LabelsLayer The LabelsLayer property determines a element that is a rendering layer of chart labels.
Legend The Legend property determines a chart legend.
LegendFormatter The LegendFormatter property determines formatting of chart legend labels.
MarkersEnabled The MarkersEnabled property determines whether chart data series markers are displayed.
MarkersSymbol The MarkersSymbol property determines a shape of chart data series marker.
PaddingBottom The PaddingBottom property determines bottom padding of chart.
PaddingLeft The PaddingLeft property determines left padding of chart.
PaddingRight The PaddingRight property determines right padding of chart.
PaddingTop The PaddingTop property determines top padding of chart.
PlotArea The PlotArea property determines chart rendering area.
Polar The Polar property determines whether a polar system of coordinates is used on a chart.
Scroller The Scroller property determines a chart scroller.
Series The Series property determines an array of chart data series.
Stacking The Stacking property determines stacking type on a chart.
ToolTipDataFormat The ToolTipDataFormat property determines tooltip data format.
ToolTipDelay The ToolTipDelay property determines a delay before a tooltip is displayed.
ToolTipFollowPointer The ToolTipFollowPointer property determines behavior of a tooltip on moving the mouse cursor.
ToolTipFormatter The ToolTipFormatter property determines a tooltip text mask.
Type The Type property determines a chart type.
UseIndicatorColorForToolTipBorder The UseIndicatorColorForToolTipBorder property determines coloring of tooltip border with series color.
UseMarkersThinning The UseMarkersThinning property determines whether markers are hidden provided at least some of them overlap each other.
UseSelectOnRightClick The UseSelectOnRightClick property determines whether chart elements are selected by the right mouse click.
UseSoftPadding The UseSoftPadding property determines whether alternative calculation of chart paddings is used.
UseZeroSubstitution The UseZeroSubstitution property determines whether empty values in data series are filled with zeros.
XAxis The XAxis property determines a chart category axis.
YAxis The YAxis property determines a chart value axis.
YSAxis The YSAxis property determines a chart secondary value axis.

Methods

  Method name Brief description
addSerie The addSerie method adds a new data series to a chart.
destroy The destroy method deletes a chart.
getColumnSeriesCount The getColumnSeriesCount method returns the number of chart data series as columns.
getForecastRange The getForecastRange method returns the maximum backward and forward forecast for a chart.
getIsCartesianChart The getIsCartesianChart method returns whether a chart uses Cartesian system of coordinates.
getIsResizing The getIsResizing method returns whether a chart is being resized.
getOriginalPlotBorders The getOriginalPlotBorders method returns an object with chart sizes and paddings considering only DOM element sizes and paddings.
getPaddings

The getPaddings method returns an object containing chart paddings.

getPaddingWasApplied The getPaddingWasApplied method returns an object containing whether chart paddings are applied.
getPlotBorders The getPlotBorders method returns an object with chart sizes and paddings.
getSelection The getSelection method returns an object containing information about selected chart series elements.
getSerie The getSerie method returns a chart data series by its index.
getSeriesStacks The getSeriesStacks method recalculates all chart stacks for further calculations.
getSeriesTypes The getSeriesTypes method returns an array of chart series.
getStackExtrems The getStackExtrems method returns calculated values of chart stacks.
hoverItems The hoverItems method sets highlighting for the specified chart series.
isWidthDataSupported The isWidthDataSupported method returns whether width and angle indicator is used.
redraw The redraw method rerenders a chart.
removeAllSeries The removeAllSeries method removes all chart data series.
removeSerie The removeSerie method removes the specified chart data series.
resize The resize method resizes a chart.
selectItems The selectItems method selects the specified chart series.
updateLegendHighlightMode The updateLegendHighlightMode method refreshes selection mode in the legend on enabling or disabling of chart editing.

Static Methods

  Method name Brief description
curve The curve method draws a curve according to the specified parameters.

Events

   Event name Brief description
Deselected The Deselected event occurs on deselecting chart element series.
ItemsHovered The ItemsHovered event occurs on hovering the cursor on a chart series.
ItemsSelected The ItemsSelected event occurs on selecting a chart series.
ItemsVisibilityChanged The ItemsVisibilityChanged occurs on changing visibility of chart data series.
PointMouseOut The PointMouseOut event occurs after the cursor leaves a chart data series point.
PointMouseOver The PointMouseOver event occurs after hovering the cursor on the chart data series point.
Rendered The Rendered event occurs on rendering a chart.
Scroll The Scroll event occurs when the chart X axis is scrolled.
Selected The Selected event occurs on selecting a chart series element.

Properties inherited from the class Control

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property sets animation parameters for component.
Bottom The Bottom property sets bottom offset on placing the component within the LayoutPanel.
Content The Content property sets the component contents.
ContextMenu The ContextMenu property sets the context menu for the component.
Data The Data property is used to store any custom data.
DataContext The DataContext property contains an object with data.
Enabled The Enabled property sets whether the component is enabled.
Height The Height property determines the component height.
IsResizable The IsResizable property determines whether the component can be resized.
IsRTL The lsRTL property sets right to left text direction.
IsVisible The IsVisible property determines whether the component is displayed.
Left The Left property sets left offset on placing the component within the GridPanel.
Offset The Offset property determines coordinates of root DOM node of a control.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property sets parent DOM node.
ResourceKey The ResourceKey property sets the resource key for the component.
Right The Right property sets right offset on placing the component within the LayoutPanel.
Rotate The Rotate property sets component rotation angle.
ShowToolTip The ShowToolTip property determines whether the tooltip of the component can be displayed.
Style The Style property sets component style.
TabIndex The TabIndex property sets the order of the control element passing inside the container.
Tag The Tag property sets JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property sets top offset on placing the component within the GridPanel.
Value The Value property sets the value to the component.
Width The Width property sets the component width.

Methods inherited from the class Control

  Method name Brief description
The addClass method adds a CSS class to the component.
addEvent The addEvent method adds an event handler to a DOM node.
addEventHandler The addEventHandler method adds an event handler to a DOM node.
addEvents The addEvents method adds an array of event handlers to a DOM node.
The addStateClass method adds a CSS class to the component and removes the previous CSS class.
addStyleBySelector The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.
The clearStylesCache method clears cache of component styles.
The getAnchorFlags method returns JSON object that contains settings of the current component's position.
The getClass method returns the current CSS classes of the component.
The getCssStyle method returns style for the specified node.
The getDomNode method returns main DOM node of the component.
The getFocused method determines whether the component is focused.
getFunctionByName The getFunctionByName method returns function by name.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.
The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
The hide method hides a control.
The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
The isResingNow method determines whether the component is being resized.
refreshBindingProperty The refreshBindingProperty method refreshes the bound property by name.
refreshItemsStyle The refreshItemsStyle method refreshes CSS styles of child elements.
refreshStyle The refreshStyle method refreshes element CSS styles.
The removeClass method removes CSS class from the component.
The removeEvent method removes event handler from DOM node.
removeEventHandler The removeEventHandler method removes event handler from DOM node.
removeFromDOM The removeFromDOM method removes node from the DOM structure.
The removeStateClasses method removes CSS classes of the component.
The setDraggable method determines whether it is possible to drag component on the HTML page.
The setFocus method sets the component focus.
The setIsHovered method displays the component as on hover.
The setIsPressed method displays the component as if clicked upon.
The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
The setSize method establishes the sizes of the component.
The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.
The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

  Event name Brief description
Drag The Drag event occurs on clicking and holding the left mouse button.
DragEnd The DragEnd event occurs when dragging the component finishes.
DragStart The DragStart event occurs when dragging the component starts.
OnContextMenu The OnContextMenu event occurs on calling context menu of the component.
SizeChanged The SizeChanged event occurs after the component is resized.
SizeChanging The SizeChanging event occurs during component resize.

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.
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.
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