API Docs for: 3.8.0
Show:

Plots Class

Defined in: charts/js/Plots.js:1
Module: charts-base
Parent Module: charts

Utility class used for drawing markers.

Methods

_clearMarkerCache

() private

Defined in charts/js/Plots.js:367

Removes unused markers from the marker cache

_createGroupMarkers

(
  • styles
)
protected

Defined in charts/js/Plots.js:287

Draws a series of markers in a single shape instance.

Parameters:

  • styles Object

    Set of configuration properties used to create the markers.

_createMarker

(
  • styles
  • order
  • index
)
private

Defined in charts/js/Plots.js:241

Creates a shape to be used as a marker.

Parameters:

  • styles Object

    Hash of style properties.

  • order Number

    Order of the series.

  • index Number

    Index within the series associated with the marker.

Returns:

Shape

_createMarkerCache

() private

Defined in charts/js/Plots.js:263

Creates a cache of markers for reuse.

_getGroupShape

(
  • shape
)
protected

Defined in charts/js/Plots.js:133

Returns the correct group shape class.

Parameters:

Returns:

Function

_getItemColor

(
  • val
  • i
)
protected

Defined in charts/js/Plots.js:418

Parses a color from an array.

Parameters:

  • val Array

    collection of colors

  • i Number

    index of the item

Returns:

String

_getPlotDefaults

() protected

Defined in charts/js/Plots.js:150

Gets the default values for series that use the utility. This method is used by the class' styles attribute's getter to get build default values.

Returns:

Object

_getState

(
  • type
)
protected

Defined in charts/js/Plots.js:476

Returns marker state based on event type

Parameters:

Returns:

String

_parseMarkerStyles

(
  • Object
)
private

Defined in charts/js/Plots.js:450

Combines new styles with existing styles.

Parameters:

  • Object Object

    containing style properties for the marker.

Returns:

Object

_setStyles

(
  • newStyles
)
protected

Defined in charts/js/Plots.js:436

Method used by styles setter. Overrides base implementation.

Parameters:

  • newStyles Object

    Hash of properties to update.

Returns:

Object

_toggleVisible

(
  • visible
)
private

Defined in charts/js/Plots.js:340

Toggles visibility

Parameters:

  • visible Boolean

    indicates visibilitye

drawPlots

() protected

Defined in charts/js/Plots.js:32

Draws the markers

getMarker

(
  • styles
  • order
  • index
)
protected

Defined in charts/js/Plots.js:199

Gets and styles a marker. If there is a marker in cache, it will use it. Otherwise it will create one.

Parameters:

  • styles Object

    Hash of style properties.

  • order Number

    Order of the series.

  • index Number

    Index within the series associated with the marker.

Returns:

Shape

updateMarkerState

(
  • type
  • i
)
protected

Defined in charts/js/Plots.js:386

Resizes and positions markers based on a mouse interaction.

Parameters:

  • type String

    state of the marker

  • i Number

    index of the marker

Properties

_groupShapes

Unknown private

Defined in charts/js/Plots.js:120

Pre-defined group shapes.

_markerCache

Array private

Defined in charts/js/Plots.js:190

Collection of markers to be re-used on a series redraw.

_markers

Array private

Defined in charts/js/Plots.js:181

Collection of markers to be used in the series.

_plotDefaults

Object private

Defined in charts/js/Plots.js:23

Storage for default marker styles.

_statSyles

Object private

Defined in charts/js/Plots.js:505