API Docs for: 3.18.1
Show:

Renderer Class

Defined in: charts/js/Renderer.js:17
Module: charts

The Renderer class is a base class for chart components that use the styles attribute.

Item Index

Methods

Properties

Attributes

Methods

_copyObject

(
  • obj
)
private

Defined in charts/js/Renderer.js:113

Copies an object literal.

Parameters:

  • obj Object

    Object literal to be copied.

Returns:

Object

_getDefaultStyles

() protected

Defined in charts/js/Renderer.js:143

Gets the default value for the styles attribute.

Returns:

Object

_mergeStyles

(
  • a
  • b
)
protected

Defined in charts/js/Renderer.js:82

Merges to object literals so that only specified properties are overwritten.

Parameters:

  • a Object

    Hash of new styles

  • b Object

    Hash of original styles

Returns:

Object

_setStyles

(
  • newStyles
)
protected

Defined in charts/js/Renderer.js:68

Method used by styles setter.

Parameters:

  • newStyles Object

    Hash of properties to update.

Returns:

Object

Properties

_styles

Object private

Defined in charts/js/Renderer.js:59

Storage for styles attribute.

Attributes

graphic

Graphic

Defined in charts/js/Renderer.js:48

The graphic in which drawings will be rendered.

Fires event graphicChange

Fires when the value for the configuration attribute graphic 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.

styles

Object

Defined in charts/js/Renderer.js:28

Style properties for class

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.