RatingChart

Namespace: PP.Ui;

Inheritance hierarchy

Object

Control

RatingChart

Description

The RatingChart class implements a rating chart.

Syntax

PP.initClass(PP.Ui.RatingChart, PP.Ui.Control, "PP.Ui.RatingChart");

Constructor

  Constructor name Brief description
RatingChart The RatingChart constructor creates an instance of the RatingChart component.

Properties

  Property name Brief description
property_image.gif ActiveColumn The ActiveColumn property determines active column of rating chart values.
property_image.gif AggregatedSerie The AggregatedSerie property determines aggregation row for data series values.
property_image.gif AggregationAfter The AggregationAfter property determines index of the row, after which data series values should be aggregated.
property_image.gif AllowMultipleSelection The AllowMultipleSelection property determines whether selecting multiple data series is allowed in a rating chart.
property_image.gif AreDataColumnsResizable The AreDataColumnsResizable property determines whether value column width can be changed using the mouse.
property_image.gif ColumnSpacing The ColumnSpacing property determines the distance between rating chart columns.
property_image.gif DataColumns The DataColumns property determines an array of rating chart value columns.
property_image.gif DataSource The DataSource property determines a data source for a rating chart.
property_image.gif DelayDuration The DelayDuration property determines animation delay for timeline step change.
property_image.gif GraphColumn The GraphColumn property determines a column with graphic view of data series.
property_image.gif Header The Header method determines a rating chart header row.
property_image.gif IndexBrush The IndexBrush property determines background fill color for data series numbers.
property_image.gif IndexColumn The IndexColumn property determines a column with data series numbers.
property_image.gif LineBrush The LineBrush property determines background fill color for data series with positive values.
property_image.gif Max The Max property determines maximum value of active value column.
property_image.gif Min The Min property determines minimum value of active value column.
property_image.gif MinColumnWidth The MinColumnWidth property determines minimum width of rating chart columns.
property_image.gif MoveActiveToEnd The MoveActiveToEnd property determines whether active value column is moved to the end.
property_image.gif MoveColumn The MoveColumn property determines a column of data series position change.
property_image.gif MoveItemsTimeout The MoveItemsTimeout property determines animation duration of data series order change.
property_image.gif NameColumn The NameColumn property determines a column with data series names.
property_image.gif NegativeLineBrush The NegativeLineBrush property determines background fill color for data series with negative values.
property_image.gif NumberFormat The NumberFormat property determines rating chart data format.
property_image.gif Series The Series property determines an array of rating chart data series.
property_image.gif ShowSplitter The ShowSplitter method determines whether a splitter is displayed on a rating chart.
property_image.gif ShowToolTip The ShowToolTip property determines whether a tooltip is displayed on a rating chart.
property_image.gif ShowValueTimeout The ShowValueTimeout property determines animation duration of rating chart change.
property_image.gif SortMethod The SortMethod property determines sorting mode for elements on a rating chart.
property_image.gif SplittedTop The SplittedTop method determines the number of data series displayed above the splitter on the first rendering of rating chart.
property_image.gif Timeline The Timeline property determines a timeline of rating chart.
property_image.gif TimelinePosition The TimelinePosition property determines timeline position for a rating chart.
property_image.gif TrendLine The TrendLine method determines a trend line of rating chart.
property_image.gif UseAnimation The UseAnimation property determines whether there is animation on a rating chart.

Methods

  Method name Brief description
sub_image.gif beginUpdate The beginUpdate method disables rating chart rerendering until the endUpdate method is called.
sub_image.gif deselectAll The deselectAll method deselects all rating chart data series.
sub_image.gif draw The draw method rerenders a rating chart.
sub_image.gif drawHeader The drawHeader method rerenders rating chart header row.
sub_image.gif endUpdate The endUpdate method enables rating chart rerendering and refreshes it.
sub_image.gif getDataColumn The getDataColumn method returns value column of rating chart by its index.
sub_image.gif getSelection The getSelection method returns array of selected data series.
sub_image.gif getSerie The getSerie method returns a rating chart data series by its index.
sub_image.gif getSerieByVerticalOffset The getSerieByVerticalOffset method returns a rating chart data series by vertical coordinate.
sub_image.gif getVisibleSeriesCount The getVisibleSeriesCount method returns the number of displayed data series.
sub_image.gif getVisibleSeriesHeight The getVisibleSeriesHeight method returns total height of displayed data series.
sub_image.gif isAggregatedSerieVisible The isAggregatedSerieVisible method returns whether data series aggregation row is visible.
sub_image.gif selectAll The selectAll method selects all rating chart data series.
sub_image.gif showToolTip The showToolTip property determines a tooltip for the specified data series.
sub_image.gif update The update method updates a rating chart.

Events

  Event name Brief description
event_image.gif DateChanged The DateChanged event occurs after rating chart timeline is changed.
event_image.gif PointClick The PointClick event occurs on clicking on a data series in a rating chart.
event_image.gif Selected The Selected event occurs after selecting a data series in a rating chart.
event_image.gif SelectionStart The SelectionStart event occurs on selecting a data series in a rating chart.
event_image.gif Sorted The Sorted event occurs after sorting of rating chart elements is completed.
event_image.gif Sorting The Sorting event occurs during sorting of rating chart elements.

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 determines component animation parameters.
Bottom The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
Content The Content property determines component contents.
ContextMenu The ContextMenu property determines a component's context menu.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether a component can be used.
Height The Height property determines component height.
IsRTL The IsRTL property determines whether component elements are aligned to the right.
IsVisible The IsVisible property determines whether a component is displayed.
Left The Left property determines a left margin if a component is placed inside GridPanel.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property determines a parent DOM node.
ResourceKey The ResourceKey property determines a component resource key.
Right The Right property determines a right margin if a component is placed inside LayoutPanel.
Rotate The Rotate property determines a component rotation angle.
ShowToolTip The ShowToolTip property determines whether a tooltip of the component can be displayed.
Style The Style property determines a component style.
TabIndex The TabIndex property determines the order of the control element passing inside the container.
Tag The Tag property determines a JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property determines a top margin if a component is placed inside GridPanel.
Value The Value property determines a component value.
Width The Width property determines component width.

Methods inherited from the class Control

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

The removeClass method removes CSS class from the component.
removeEventHandler The removeEventHandler method removes event handler from DOM node.
removeFromDOM The removeFromDOM method removes node from the DOM structure.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

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