#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# Plots Class

Defined in: `charts/js/Plots.js:11`
Module: series-plot-util
Parent Module: charts

Utility class used for drawing markers.

## Constructor

### `Plots`

()

Defined in `charts/js/Plots.js:11`

- Index
- Methods
- Properties

## Item Index

### Methods

- _clearMarkerCache
- _createGroupMarkers
- _createMarker
- _createMarkerCache
- _getDefaultStyles
- _getGroupShape
- _getItemColor
- _getPlotDefaults
- _getState
- _parseMarkerStyles
- _setStyles
- _toggleVisible
- drawPlots
- drawSeries
- getMarker
- updateMarkerState

### Properties

- _groupShapes
- _markerCache
- _markers
- _plotDefaults
- _statSyles

## Methods

### `_clearMarkerCache`

() private

Defined in `charts/js/Plots.js:373`

Removes unused markers from the marker cache

### `_createGroupMarkers`

(

- `styles`

)
protected

Defined in `charts/js/Plots.js:293`

Draws a series of markers in a single shape instance.

#### Parameters:

- `styles` Object

  Set of configuration properties used to create the markers.

### `_createMarker`

(

- `styles`

)
private

Defined in `charts/js/Plots.js:250`

Creates a shape to be used as a marker.

#### Parameters:

- `styles` Object

  Hash of style properties.

#### Returns:

Shape

### `_createMarkerCache`

() private

Defined in `charts/js/Plots.js:269`

Creates a cache of markers for reuse.

### `_getDefaultStyles`

() protected

Defined in `charts/js/Plots.js:530`

#### Returns:

Object

### `_getGroupShape`

(

- `shape`

)
protected

Defined in `charts/js/Plots.js:142`

Returns the correct group shape class.

#### Parameters:

- `shape` Shape | String

  Indicates which shape class.

#### Returns:

Function

### `_getItemColor`

(

- `val`
- `i`

)
protected

Defined in `charts/js/Plots.js:424`

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:159`

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:482`

Returns marker state based on event type

#### Parameters:

- `type` String

  event type

#### Returns:

String

### `_parseMarkerStyles`

(

- `Object`

)
private

Defined in `charts/js/Plots.js:456`

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:442`

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:346`

Toggles visibility

#### Parameters:

- `visible` Boolean

  indicates visibilitye

### `drawPlots`

() protected

Defined in `charts/js/Plots.js:41`

Draws the markers

### `drawSeries`

() protected

Defined in `charts/js/Plots.js:518`

### `getMarker`

(

- `styles`
- `order`
- `index`

)
protected

Defined in `charts/js/Plots.js:208`

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:392`

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:129`

Pre-defined group shapes.

### `_markerCache`

Array private

Defined in `charts/js/Plots.js:199`

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

### `_markers`

Array private

Defined in `charts/js/Plots.js:190`

Collection of markers to be used in the series.

### `_plotDefaults`

Object private

Defined in `charts/js/Plots.js:32`

Storage for default marker styles.

### `_statSyles`

Object private

Defined in `charts/js/Plots.js:511`