API Docs for: 3.8.0
Show:

MarkerSeries Class

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

The MarkerSeries class renders quantitative data by plotting relevant data points on a graph.

Item Index

Methods

Attributes

Methods

_getDefaultStyles

() protected

Defined in charts/js/MarkerSeries.js:44

Returns:

Object

_setStyles

(
  • newStyles
)
protected

Defined in charts/js/MarkerSeries.js:25

Parameters:

  • newStyles Object

    Hash of properties to update.

Returns:

Object

drawSeries

() protected

Defined in charts/js/MarkerSeries.js:13

Attributes

styles

Object

Defined in charts/js/MarkerSeries.js:71

Style properties used for drawing markers. This attribute is inherited from Renderer. Below are the default values:

fill
A hash containing the following values:
color
Color of the fill. The default value is determined by the order of the series on the graph. The color will be retrieved from the below array:
["#6084d0", "#eeb647", "#6c6b5f", "#d6484f", "#ce9ed1", "#ff9f3b", "#93b7ff", "#e0ddd0", "#94ecba", "#309687"]
alpha
Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
border
A hash containing the following values:
color
Color of the border. The default value is determined by the order of the series on the graph. The color will be retrieved from the below array:
["#205096", "#b38206", "#000000", "#94001e", "#9d6fa0", "#e55b00", "#5e85c9", "#adab9e", "#6ac291", "#006457"]
alpha
Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
weight
Number indicating the width of the border. The default value is 1.
width
indicates the width of the marker. The default value is 10.
height
indicates the height of the marker The default value is 10.
over
hash containing styles for markers when highlighted by a mouseover event. The default values for each style is null. When an over style is not set, the non-over value will be used. For example, the default value for marker.over.fill.color is equivalent to marker.fill.color.

Fires event stylesChange

Fires when the value for the configuration attribute styles is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

type

String

Defined in charts/js/MarkerSeries.js:60

Read-only attribute indicating the type of series.

Default: marker

Fires event typeChange

Fires when the value for the configuration attribute type is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.