dundas.controls.ChartCursor Class

Defines the chart's selection cursor settings and current position.
 

Inheritance Hierarchy

 
Class
   dundas.controls.ChartCursor
 

Constructors

 
  Name Description
init Initializes the chart selection cursor.
 
 

Properties

 
  Name Description
endXValue Gets or sets the ending X axis value of the cursor, or null if the cursor is not active. This property is ignored if isXEnabled is false.
endYValue Gets or sets the ending Y axis value of the cursor, or null if the cursor is not active. This property is ignored if isYEnabled is false.
fill Gets or sets the brush used to fill the cursor area.
fillOpacity Gets or sets the percentage of opacity of the cursor fill.
isCrosshairVisible Gets or sets whether the cursor strokes are extended to the edges of the plotting area.
isCrossSectionSelectedOnHover Gets or sets a value indicating whether the selection cursor moves with the mouse (or on tap) along the X axis and selects a cross section of data points located at or near each position.
isMovable Gets or sets whether the cursor area can be moved after the cursor is set.
isResizable Gets or sets whether the cursor area can be resized after the cursor is set.
isXEnabled Gets or sets whether the cursor is enabled along the X dimension of the chart.
isYEnabled Gets or sets whether the cursor is enabled along the Y dimension of the chart.
selectedEndXValue Gets the starting X axis value most recently selected by the cursor when user selection ended.
selectedEndYValue Gets the ending Y axis value most recently selected by the cursor when user selection ended.
selectedStartXValue Gets the starting X axis value most recently selected by the cursor when user selection ended.
selectedStartYValue Gets the starting Y axis value most recently selected by the cursor when user selection ended.
selectionMode Gets or sets what action should be taken when an area is selected.
startXValue Gets or sets the starting X axis value of the cursor, or null if the cursor is not active. This property is ignored if isXEnabled is false.
startYValue Gets or sets the starting Y axis value of the cursor, or null if the cursor is not active. This property is ignored if isYEnabled is false.
stroke Gets or sets the brush used to draw the cursor lines.
strokeDashType Gets or sets the pattern of dashes used to draw the cursor lines.
strokeOpacity Gets or sets the percentage of opacity of the cursor line stroke.
strokeWidth Gets or sets the width of the cursor lines.
unselectedFill Gets or sets the brush used to fill the plotting area except the cursor area.
unselectedFillOpacity Gets or sets the percentage of opacity of the unselected fill.
xAxisType Gets or sets the type of X axis the cursor values are relative to.
yAxisType Gets or sets the type of Y axis the cursor values are relative to.
 
 

Methods

 
  Name Description
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
invalidate Ensures the data control is re-drawn using the current data and settings at the next best time made available by the browser. This method is normally called automatically when needed.
toString Creates a string representation of this instance.