StockChartX Web & Mobile

Class: Plot

StockChartX. Plot

<abstract> new Plot(config)

Represents abstract plot.
Parameters:
Name Type Argument Description
config Object <optional>
 The configuration object.
Properties
Name Type Argument Description
dataSeries Array.<StockChartX.DataSeries> <optional>
 An array of data series for the plot.
chartPanel Object <optional>
 The parent chart panel.
theme Object <optional>
 The plot's theme.
plotType String <optional>
 The plot type.

Extends

Members

actualTheme :Object

Gets actual plot theme.
Type:
  • Object

<readonly> chart :StockChartX.Chart

Gets parent chart.
Type:
Inherited From:

chartPanel :StockChartX.ChartPanel

Gets/Sets parent chart panel.
Type:
Inherited From:

dataSeries :Array

An array of data series used by plot.
Type:
  • Array

<readonly> panelValueScale :StockChartX.ChartPanelValueScale

Gets chart panel value scale.
Type:
Inherited From:

plotStyle :string

Gets/Sets plot style.
Type:
  • string

plotType :string

Gets plot type.
Type:
  • string

<readonly> projection :StockChartX.Projection

Gets projection object to convert coordinates.
Type:
Inherited From:

showValueMarkers :boolean

Gets/Sets the flag that indicates whether value markers are visible.
Type:
  • boolean

theme :Object

The theme.
Type:
  • Object

visible :boolean

Gets/Sets flag that indicates whether drawing is visible.
Type:
  • boolean
Inherited From:

Methods

draw()

Draws object.
Inherited From:

fire(event, newValue, oldValue)

Fires event.
Parameters:
Name Type Argument Description
event String The event name.
newValue * <optional>
 The new property value.
oldValue * <optional>
 The old property value.
Inherited From:
Example
obj.fire('custom_event', 'new value', 'old value');

minMaxValues(startIndex, count)

Returns minimum and maximum values in a given range.
Parameters:
Name Type Argument Description
startIndex Number <optional>
 The start search index. 0 if omitted.
count Number <optional>
 The number of values to iterate through. Iterates through all values after startIndex if omitted.
Returns:
An object that contains min and max values.
Type
Object
Example
var values1 = plot.getMinMaxValues();
 var values2 = plot.getMinMaxValues(1, 5);

saveState()

Saves chart panel object state.
Inherited From:
Overrides:
Returns:
Type
object

setDataSeries(dataSeries)

Sets 1 or more data series.
Parameters:
Name Type Description
dataSeries StockChartX.DataSeries | Array.<StockChartX.DataSeries> The data series.

suppressEvents(suppress)

Suppresses/Allows all events.
Parameters:
Name Type Argument Default Description
suppress boolean <optional>
 true The flag to suppress or resume events raising.
Inherited From:
Returns:
The old value.
Type
boolean
Examples

Suppress events

 obj.suppressEvents();

Resume events

 obj.suppressEvents(false);