API Docs for: 3.10.3
Show:

TimeAxis Class

Uses
Extends Axis
Defined in: charts/js/TimeAxis.js:7
Module: axis-time
Parent Module: charts

TimeAxis draws a time-based axis for a chart.

Constructor

TimeAxis

(
  • config
)

Defined in charts/js/TimeAxis.js:7

Parameters:

  • config Object

    (optional) Configuration parameters.

Item Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

(
  • cfgs
  • values
  • lazy
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:836

Implementation behind the public addAttrs method.

This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

Parameters:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

  • lazy Boolean

    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

_addLazyAttr

(
  • name
  • [lazyCfg]
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:382

Finishes initializing an attribute which has been lazily added.

Parameters:

  • name Object

    The name of the attribute

  • [lazyCfg] Object optional

    Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

_afterChildSelectedChange

(
  • event
)
protected

Inherited from Widget: widget-child/js/Widget-Child.js:327

Default attribute change listener for the selected attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • event EventFacade

    The event facade for the attribute change.

_aggregateAttrs

(
  • allAttrs
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:575

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.

The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).

Parameters:

  • allAttrs Array

    An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object: The aggregate set of ATTRS definitions for the instance

_applyParsedConfig

() Object protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:83

Returns:

Object: The merged configuration literal

_applyParser

(
  • config
)
protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:92

Utility method used to apply the HTML_PARSER configuration for the instance, to retrieve config data values.

Parameters:

  • config Object

    User configuration object (will be populated with values from Node)

_attrCfgHash

() private

Inherited from BaseCore: base/js/BaseCore.js:538

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

_baseDestroy

() private

Inherited from BaseCore: base/js/BaseCore.js:309

Internal destroy implementation for BaseCore

_baseInit

() private

Inherited from BaseCore: base/js/BaseCore.js:281

Internal initialization implementation for BaseCore

_bindAttrUI

(
  • attrs
)
private

Inherited from Widget: widget/js/Widget.js:1170

Binds after listeners for the list of attributes provided

Parameters:

_bindDOM

() protected

Inherited from Widget: widget/js/Widget.js:902

Sets up DOM listeners, on elements rendered by the widget.

_bindUI

() protected

Inherited from Widget: widget/js/Widget.js:883

Sets up DOM and CustomEvent listeners for the widget.

_bindUIChild

() protected

Inherited from Widget: widget-child/js/Widget-Child.js:356

Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

_clearLabelCache

() private

Inherited from Axis: charts/js/Axis.js:760

Removes axis labels from the dom and clears the label cache.

_cloneDefaultValue

(
  • cfg
)
private

Inherited from BaseCore: base/js/BaseCore.js:549

This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.

Parameters:

_createLabelCache

() private

Inherited from Axis: charts/js/Axis.js:738

Creates a cache of labels that can be re-used when the axis redraws.

_createUIEvent

(
  • type
)
private

Inherited from Widget: widget/js/WidgetUIEvents.js:73

Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.

Parameters:

  • type String

    String representing the name of the event

_dataChangeHandler

(
  • e
)
private

Inherited from Axis: charts/js/Axis.js:72

Handles change to the dataProvider

Parameters:

_dataProviderChangeHandler

(
  • e
)
private

Inherited from AxisBase: charts/js/AxisBase.js:40

Handles changes to dataProvider.

Parameters:

_defAttrChangeFn

(
  • e
)
private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:186

Default function for attribute change events.

Parameters:

  • e EventFacade

    The event object for attribute change events.

_defaultCB

() protected

Inherited from Widget: widget/js/Widget.js:780

Returns the default value for the contentBox attribute.

For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

_defDestroyFn

(
  • e
)
protected

Inherited from BaseObservable: base/js/BaseObservable.js:190

Default destroy event handler

Parameters:

_defInitFn

(
  • e
)
protected

Inherited from BaseObservable: base/js/BaseObservable.js:178

Default init event handler

Parameters:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.

_defRenderFn

(
  • e
  • parentNode
)
protected

Inherited from Widget: widget/js/Widget.js:571

Default render handler

Parameters:

  • e EventFacade

    The Event object

  • parentNode Node

    The parent node to render to, if passed in to the render method

_destroyBox

() protected

Inherited from Widget: widget/js/Widget.js:476

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

_destroyHierarchy

() private

Inherited from BaseCore: base/js/BaseCore.js:721

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

_destroyUIEvents

() private

Inherited from Widget: widget/js/WidgetUIEvents.js:20

Destructor logic for UI event infrastructure, invoked during Widget destruction.

_drawAxis

() private

Inherited from Axis: charts/js/Axis.js:374

Draws an axis.

_filterAdHocAttrs

(
  • allAttrs
  • userVals
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:427

Parameters:

  • allAttrs Object

    The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

  • userVals Object

    The config object passed in by the user, from which adhoc attrs are to be filtered.

Returns:

Object: The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

_filterAttrCfgs

(
  • clazz
  • allCfgs
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:356

A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in.

Parameters:

  • clazz Function

    The class for which the desired attributes are required.

  • allCfgs Object

    The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

Returns:

Object: The set of attributes belonging to the class passed in, in the form of an object with attribute name/configuration pairs.

_filterUIEvent

(
  • evt
)
Boolean private

Inherited from Widget: widget/js/WidgetUIEvents.js:117

This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.

For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.

Parameters:

Returns:

Boolean: true if it's OK to fire the custom UI event, false if not.

_fireAttrChange

(
  • attrName
  • subAttrName
  • currVal
  • newVal
  • opts
  • [cfg]
)
private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

  • attrName String

    The name of the attribute

  • subAttrName String

    The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.

  • currVal Any

    The current value of the attribute

  • newVal Any

    The new value of the attribute

  • opts Object

    Any additional event data to mix into the attribute change event's event facade.

  • [cfg] Object optional

    The attribute config stored in State, if already available.

_getAttr

(
  • name
)
Any protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:543

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See get for argument details.

Parameters:

  • name String

    The name of the attribute.

Returns:

Any: The value of the attribute.

_getAttrCfg

(
  • name
)
Object protected

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:114

Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.

Parameters:

  • name String

    Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object: The configuration properties for the given attribute, or all attributes.

_getAttrCfgs

() Object protected

Inherited from BaseCore: base/js/BaseCore.js:339

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object: The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

_getAttrInitVal

(
  • attr
  • cfg
  • initValues
)
Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:945

Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.

Parameters:

  • attr String

    The name of the attribute

  • cfg Object

    The attribute configuration object

  • initValues Object

    The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any: The initial value of the attribute.

_getAttrs

(
  • attrs
)
Object protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:774

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

  • attrs Array | boolean

    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

_getClasses

() Function[] protected

Inherited from BaseCore: base/js/BaseCore.js:323

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function[]: An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

_getDataFromLabelValues

(
  • startPoint
  • labelValues
  • edgeOffset
  • layoutLength
)
private

Defined in charts/js/TimeAxis.js:40

Calculates the position of ticks and labels based on an array of specified label values. Returns an object containing an array of values to be used for labels and an array of objects containing x and y coordinates for each label.

Parameters:

  • startPoint Object

    An object containing the x and y coordinates for the start of the axis.

  • labelValues Array

    An array containing values to be used for determining the number and position of labels and ticks on the axis.

  • edgeOffset Number

    The distance, in pixels, on either edge of the axis.

  • layoutLength Number

    The length, in pixels, of the axis. If the axis is vertical, the length is equal to the height. If the axis is horizontal, the length is equal to the width.

Returns:

Object

_getDefaultMargins

() private

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:11

Default margins for text fields.

Returns:

Object

_getDefaultStyles

() protected

Inherited from AxisBase but overwritten in charts/js/Axis.js:214

Gets the default value for the styles attribute. Overrides base implementation.

Returns:

Object

_getFullType

(
  • type
)
String private

Inherited from EventTarget: event-custom/js/event-target.js:586

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.

Parameters:

  • type String

    The short type to prefix

Returns:

String: The prefixed type, if a prefix is set, otherwise the type passed in

_getHtmlParser

() Object private

Inherited from Widget: widget/js/WidgetHTMLParser.js:149

Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.

Returns:

Object: HTML_PARSER definition for this instance

_getKeyArray

(
  • key
  • data
)
private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:186

Gets an array of values based on a key.

Parameters:

  • key String

    Value key associated with the data array.

  • data Array

    Array in which the data resides.

Returns:

Array

_getLabelBounds

(
  • Value
)
private

Inherited from Axis: charts/js/Axis.js:1017

Returns the coordinates (top, right, bottom, left) for the bounding box of a label.

Parameters:

Returns:

Object

_getLabelByIndex

(
  • i
  • l
)
private

Defined in charts/js/TimeAxis.js:18

Calculates and returns a value based on the number of labels and the index of the current label.

Parameters:

  • i Number

    Index of the label.

  • l Number

    Total number of labels.

Returns:

String

_getNodeToParse

() Node private

Inherited from Widget: widget/js/WidgetHTMLParser.js:134

Determines whether we have a node reference which we should try and parse.

The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.

Returns:

Node: The node reference to apply HTML_PARSER to.

_getNumber

(
  • val
)
private

Inherited from TimeImpl: charts/js/TimeImpl.js:277

Parses value into a number.

Parameters:

  • val Object

    Value to parse into a number

Returns:

Number

_getPoints

(
  • startPoint
  • len
  • edgeOffset
  • majorUnitDistance
  • direction
)
private

Inherited from Axis: charts/js/Axis.js:857

Calculates points based off the majorUnit count or distance of the Axis.

Parameters:

  • startPoint Object

    An object literal containing the x and y coordinates of the first point on the axis.

  • len Number

    The number of points on an axis.

  • edgeOffset Number

    The distance from the start of the axis and the point.

  • majorUnitDistance Number

    The distance between points on an axis.

  • direction String

    Indicates whether the axis is horizontal or vertical.

Returns:

Array

_getSetMax

() private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:124

Indicates whether or not the maximum attribute has been explicitly set.

Returns:

Boolean

_getSetMin

() private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:137

Indicates whether or not the minimum attribute has been explicitly set.

Returns:

Boolean

_getSrcNode

() Node protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:74

Returns:

Node: The Node to apply HTML_PARSER to

_getStateVal

(
  • name
  • [cfg]
)
Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:600

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

  • name String

    The name of the attribute

  • [cfg] Object optional

    Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Any: The stored value of the attribute

_getStrings

(
  • locale
)
protected

Inherited from Widget: widget/js/WidgetLocale.js:56

Returns the strings key/value hash for a paricular locale, without locale lookup applied.

Parameters:

_getTextRotationProps

(
  • styles
)
private

Inherited from Axis: charts/js/Axis.js:334

Generates the properties necessary for rotating and positioning a text field.

Parameters:

  • styles Object

    properties for the text field

Returns:

Object

_getTransformOrigin

(
  • rot
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:289

Returns the transformOrigin to use for an axis label based on the position of the axis and the rotation of the label.

Parameters:

  • rot Number

    The rotation (in degrees) of the label.

Returns:

Array

_getType

() private

Inherited from EventTarget: event-custom/js/event-target.js:36

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

_getUIEventNode

() protected

Inherited from Widget but overwritten in widget-child/js/Widget-Child.js:167

Returns the node on which to bind delegate listeners.

Override of Widget's implementation of _getUIEventNode() to ensure that all event listeners are bound to the Widget's topmost DOM element. This ensures that the firing of each type of Widget UI event (click, mousedown, etc.) is facilitated by a single, top-level, delegated DOM event listener.

_guid

() protected

Inherited from Widget: widget/js/Widget.js:1153

_handleSizeChange

(
  • e
)
private

Inherited from Axis: charts/js/Axis.js:282

Updates the axis when the size changes.

Parameters:

_hasDataOverflow

() protected

Inherited from Axis: charts/js/Axis.js:1183

Checks to see if data extends beyond the range of the axis. If so, that data will need to be hidden. This method is internal, temporary and subject to removal in the future.

Returns:

Boolean

_initAttrHost

(
  • attrs
  • values
  • lazy
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

  • attrs Object

    The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

  • values Object

    The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

  • lazy Boolean

    Whether or not to add attributes lazily (passed through to addAttrs).

_initAttribute

() private

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:254

Initializes AttributeCore

_initAttrs

(
  • attrs
  • values
  • lazy
)
protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:1011

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

  • attrs Object

    The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

  • values Object

    The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

  • lazy Boolean

    Whether or not to add attributes lazily (passed through to addAttrs).

_initBase

(
  • config
)
private

Inherited from BaseCore: base/js/BaseCore.js:219

Internal construction logic for BaseCore.

Parameters:

  • config Object

    The constructor configuration object

_initHierarchy

(
  • userVals
)
private

Inherited from BaseCore: base/js/BaseCore.js:659

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

  • userVals Object

    Object with configuration property name/value pairs

_initHierarchyData

() private

Inherited from BaseCore: base/js/BaseCore.js:457

A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.

_initUIEvent

(
  • type
)
String private

Inherited from Widget: widget/js/WidgetUIEvents.js:176

Sets up infrastructure required to fire a UI event.

Parameters:

  • type String

    String representing the name of the event

Returns:

String:

_isLazyAttr

(
  • name
)
Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:369

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

  • name String

    The name of the attribute

Returns:

Boolean: true if it's a lazily added attribute, false otherwise.

_isUIEvent

(
  • type
)
String private

Inherited from Widget: widget/js/WidgetUIEvents.js:143

Determines if the specified event is a UI event.

Parameters:

  • type String

    String representing the name of the event

Returns:

String: Event Returns the name of the UI Event, otherwise undefined.

_keyChangeHandler

(
  • e
)
private

Inherited from AxisBase: charts/js/AxisBase.js:308

Updates the Axis after a change in keys.

Parameters:

_mapInstance

(
  • The
)
protected

Inherited from Widget: widget/js/Widget.js:414

Utility method used to add an entry to the boundingBox id to instance map.

This method can be used to populate the instance with lazily created boundingBox Node references.

Parameters:

_maximumGetter

() private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:64

Getter method for maximum attribute.

Returns:

Number

_maximumSetter

(
  • value
)
private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:81

Setter method for maximum attribute.

Parameters:

_minimumGetter

() private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:94

Getter method for minimum attribute.

Returns:

Number

_minimumSetter

(
  • value
)
private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:111

Setter method for minimum attribute.

Parameters:

_monitor

(
  • what
  • eventType
  • o
)
private

Inherited from EventTarget: event-custom/js/event-target.js:658

This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> clickattach, clickdetach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.

Parameters:

  • what String

    'attach', 'detach', 'fire', or 'publish'

  • eventType String | CustomEvent

    The prefixed name of the event being monitored, or the CustomEvent object.

  • o Object

    Information about the event interaction, such as fire() args, subscription category, publish config

_normAttrVals

(
  • valueHash
)
Object private

Inherited from AttributeCore: attribute/js/AttributeCore.js:897

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

  • valueHash Object

    An object with attribute name/value pairs

Returns:

Object: An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

_onDocFocus

(
  • evt
)
protected

Inherited from Widget: widget/js/Widget.js:1081

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

  • evt EventFacade

    The event facade for the DOM focus event

_onDocMouseDown

(
  • evt
)
protected

Inherited from Widget: widget/js/Widget.js:1068

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

  • evt EventFacade

    The event facade for the DOM focus event

_parseType

() private

Inherited from EventTarget: event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

_positionChangeHandler

(
  • e
)
private

Inherited from Axis: charts/js/Axis.js:87

Handles change to the position attribute

Parameters:

_preInitEventCfg

(
  • config
)
private

Inherited from BaseObservable: base/js/BaseObservable.js:98

Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.

Parameters:

  • config Object

    The user configuration object

_protectAttrs

(
  • attrs
)
Object deprecated protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:883

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

  • attrs Object

    A hash of attribute to configuration object pairs.

Returns:

Object: A protected version of the attrs argument.

_publish

(
  • fullType
  • etOpts
  • ceOpts
)
CustomEvent private

Inherited from EventTarget: event-custom/js/event-target.js:610

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the type to fullType conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

Parameters:

  • fullType String

    The prefixed type of the event to publish.

  • etOpts Object

    The EventTarget specific configuration to mix into the published event.

  • ceOpts Object

    The publish specific configuration to mix into the published event.

Returns:

CustomEvent: The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

_removeChildren

() private

Inherited from Axis: charts/js/Axis.js:1048

Removes all DOM elements from an HTML element. Used to clear out labels during detruction phase.

_removeLoadingClassNames

() protected

Inherited from Widget: widget/js/Widget.js:862

Removes class names representative of the widget's loading state from the boundingBox.

_renderBox

(
  • parentNode
)
private

Inherited from Widget: widget/js/Widget.js:710

Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.

Parameters:

  • parentNode Node

    The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.

_renderBoxClassNames

() protected

Inherited from Widget: widget/js/Widget.js:838

Applies standard class names to the boundingBox and contentBox

_renderUI

() protected

Inherited from Widget: widget/js/Widget.js:827

Initializes the UI state for the Widget's bounding/content boxes.

_rotate

(
  • label
  • props
)
private

Inherited from Axis: charts/js/Axis.js:906

Rotates and positions a text field.

Parameters:

  • label HTMLElement

    text field to rotate and position

  • props Object

    properties to be applied to the text field.

_set

(
  • name
  • val
  • [opts]
)
Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:427

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

  • name String

    The name of the attribute.

  • val Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

_setAttr

(
  • name
  • value
  • [opts]
  • force
)
Object protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:443

Provides the common implementation for the public set and protected _set methods.

See set for argument details.

Parameters:

  • name String

    The name of the attribute.

  • value Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

  • force Boolean

    If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object: A reference to the host object.

_setAttrs

(
  • attrs
  • [opts]
)
Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:742

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

  • [opts] Object optional

    Optional data providing the circumstances for the change

Returns:

Object: A reference to the host object.

_setAttrUI

(
  • e
)
private

Inherited from Widget: widget/js/Widget.js:1201

Parameters:

_setAttrVal

(
  • attrName
  • subAttrName
  • prevVal
  • newVal
  • [opts]
  • [attrCfg]
)
Booolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:640

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

  • attrName String

    The attribute name.

  • subAttrName String

    The sub-attribute name, if setting a sub-attribute property ("x.y.z").

  • prevVal Any

    The currently stored value of the attribute.

  • newVal Any

    The value which is going to be stored.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

  • [attrCfg] Object optional

    Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Booolean: true if the new attribute value was stored, false if not.

_setBB

(
  • Node/String
)
private

Inherited from Widget: widget/js/Widget.js:756

Setter for the boundingBox attribute

Parameters:

Returns:

Node

_setBox

(
  • id
  • node
  • template
  • true
)
Node private

Inherited from Widget: widget/js/Widget.js:793

Helper method to set the bounding/content box, or create it from the provided template if not found.

Parameters:

  • id String

    The node's id attribute

  • node Node | String

    The node reference

  • template String

    HTML string template for the node

  • true Boolean

    if this is the boundingBox, false if it's the contentBox

Returns:

Node: The node

_setCanvas

() private

Inherited from Axis: charts/js/Axis.js:181

Creates a graphic instance to be used for the axis line and ticks.

_setCB

(
  • node
)
private

Inherited from Widget: widget/js/Widget.js:768

Setter for the contentBox attribute

Parameters:

Returns:

Node

_setRotationCoords

(
  • props
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:254

Adjusts the coordinates of an axis label based on the rotation.

Parameters:

  • props Object

    Coordinates, dimension and rotation properties of the label.

_setStateVal

(
  • name
  • value
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:622

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

  • name String

    The name of the attribute

  • value Any

    The value of the attribute

_setStrings

(
  • strings
  • locale
)
protected

Inherited from Widget: widget/js/WidgetLocale.js:35

Sets strings for a particular locale, merging with any existing strings which may already be defined for the locale.

Parameters:

  • strings Object

    The hash of string key/values to set

  • locale Object

    The locale for the string values being set

_setText

(
  • label
  • val
)
private

Inherited from Axis: charts/js/Axis.js:1107

Updates the content of text field. This method writes a value into a text field using appendChild. If the value is a String, it is converted to a TextNode first.

Parameters:

  • label HTMLElement

    label to be updated

  • val String

    value with which to update the label

_setTotalTitleSize

(
  • styles
)
private

Inherited from Axis: charts/js/Axis.js:559

Calculates and sets the total size of a title.

Parameters:

  • styles Object

    Properties for the title field.

_simulateTransformOrigin

(
  • matrix
  • rot
  • transformOrigin
  • w
  • h
)
private

Inherited from Axis: charts/js/Axis.js:972

Simulates a rotation with a specified transformOrigin.

Parameters:

  • matrix Matrix

    Reference to a Matrix instance.

  • rot Number

    The rotation (in degrees) that will be performed on a matrix.

  • transformOrigin Array

    An array represeniting the origin in which to perform the transform. The first index represents the x origin and the second index represents the y origin.

  • w Number

    The width of the object that will be transformed.

  • h Number

    The height of the object that will be transformed.

_strSetter

(
  • strings
)
String protected

Inherited from Widget: widget/js/Widget.js:1212

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

Parameters:

Returns:

String: The full set of strings to set

_syncAttrUI

(
  • attrs
)
private

Inherited from Widget: widget/js/Widget.js:1186

Invokes the _uiSet=ATTR NAME> method for the list of attributes provided

Parameters:

_syncUI

() protected

Inherited from Widget: widget/js/Widget.js:964

Updates the widget UI to reflect the attribute state.

_syncUIChild

() protected

Inherited from Widget: widget-child/js/Widget-Child.js:341

Synchronizes the UI to match the WidgetChild state.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

_uiSetChildSelected

(
  • selected
)
protected

Inherited from Widget: widget-child/js/Widget-Child.js:305

Updates the UI to reflect the selected attribute value.

Parameters:

  • selected Number

    The selected value to be reflected in the UI.

_uiSetDim

(
  • dim
  • val
)
private

Inherited from Widget: widget/js/Widget.js:997

Parameters:

_uiSetDisabled

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:1018

Sets the disabled state for the UI

Parameters:

_uiSetFocused

(
  • val
  • src
)
protected

Inherited from Widget: widget/js/Widget.js:1029

Sets the focused state for the UI

Parameters:

  • val Boolean
  • src String

    String representing the source that triggered an update to the UI.

_uiSetHeight

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:974

Sets the height on the widget's bounding box element

Parameters:

_uiSetTabIndex

(
  • Number
)
protected

Inherited from Widget: widget/js/Widget.js:1051

Set the tabIndex on the widget's rendered UI

Parameters:

_uiSetVisible

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:1007

Sets the visible state for the UI

Parameters:

_uiSetWidth

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:986

Sets the width on the widget's bounding box element

Parameters:

_uiSizeCB

(
  • expand
)
protected

Inherited from Widget: widget/js/Widget.js:701

Parameters:

_unbindDOM

() protected

Inherited from Widget: widget/js/Widget.js:933

_unbindUI

() protected

Inherited from Widget: widget/js/Widget.js:894

_updateGraphic

(
  • position
)
private

Inherited from Axis: charts/js/Axis.js:100

Updates the the Graphic instance

Parameters:

  • position String

    Position of axis

_updateHandler

(
  • e
)
private

Inherited from Axis: charts/js/Axis.js:126

Handles changes to axis.

Parameters:

_updateMinAndMax

() private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:241

Calculates the maximum and minimum values for the Axis.

_updatePathElement

() private

Inherited from Axis: charts/js/Axis.js:599

Updates path.

_updateTitle

() private

Inherited from Axis: charts/js/Axis.js:627

Updates the content and style properties for a title field.

_updateTotalData

() private

Inherited from AxisBase: charts/js/AxisBase.js:177

Updates the total data array.

_validTabIndex

(
  • tabIndex
)
protected

Inherited from Widget: widget/js/Widget.js:1161

Parameters:

addAttr

(
  • name
  • config
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:157

Adds an attribute with the provided configuration to the host object.

The config argument object supports the following properties:

value <Any>
The initial value to set on the attribute
valueFn <Function | String>

A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.

valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.

readOnly <boolean>
Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
writeOnce <boolean> or <string>
Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set.

The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)

setter <Function | String>

The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.

setter can also be set to a string, representing the name of the instance method to be used as the setter function.

getter <Function | String>

The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.

getter can also be set to a string, representing the name of the instance method to be used as the getter function.

validator <Function | String>

The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.

validator can also be set to a string, representing the name of the instance method to be used as the validator function.

lazyAdd <boolean>
Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.

The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

  • name String

    The name of the attribute.

  • config Object

    An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

    NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.

  • lazy Boolean

    (optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object: A reference to the host object.

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:805

Configures a group of attributes, and sets initial values.

NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

  • lazy Boolean

    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

Returns:

Object: A reference to the host object.

addKey

(
  • value
)

Inherited from AxisBase: charts/js/AxisBase.js:142

Adds an array to the key hash.

Parameters:

  • value Object

    Indicates what key to use in retrieving the array.

addTarget

(
  • o
)

Inherited from EventTarget: event-custom/js/event-facade.js:455

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.

Events can only bubble if emitFacade is true.

Included in the event-custom-complex submodule.

Parameters:

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:833

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

ancestor

(
  • depth
)
Widget

Inherited from Widget: widget-child/js/Widget-Child.js:279

Returns the Widget instance at the specified depth.

Parameters:

  • depth Number

    Number representing the depth of the ancestor.

Returns:

Widget: Widget instance.

attrAdded

(
  • name
)
Boolean

Inherited from AttributeCore: attribute/js/AttributeCore.js:341

Checks if the given attribute has been added to the host

Parameters:

  • name String

    The name of the attribute to check.

Returns:

Boolean: true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

before

()

Inherited from EventTarget: event-custom/js/event-target.js:870

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

detach handle

bindUI

() private

Inherited from Widget but overwritten in charts/js/Axis.js:38

blur

() chainable

Inherited from Widget: widget/js/Widget.js:673

Causes the Widget to lose focus by setting the "focused" attribute to "false"

bubble

(
  • evt
)
Boolean

Inherited from EventTarget: event-custom/js/event-facade.js:507

Propagate an event. Requires the event-custom-complex module.

Parameters:

Returns:

Boolean: the aggregated return value from Event.Custom.fire

destroy

(
  • destroyAllNodes
)
Widget chainable

Inherited from BaseObservable but overwritten in widget/js/Widget.js:452

Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy

Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.

Parameters:

  • destroyAllNodes Boolean

    If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.

Returns:

Widget: A reference to this object

destructor

() protected

Inherited from Widget but overwritten in charts/js/Axis.js:1069

Destructor implementation Axis class. Removes all labels and the Graphic instance from the widget.

detach

(
  • type
  • fn
  • context
)
EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:346

Detach one or more listeners the from the specified event

Parameters:

  • type String | Object

    Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.

  • fn Function

    The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.

  • context Object

    The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)

Returns:

EventTarget: the host

detachAll

(
  • type
)

Inherited from EventTarget: event-custom/js/event-target.js:469

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

disable

() chainable

Inherited from Widget: widget/js/Widget.js:692

Set the Widget's "disabled" attribute to "true".

drawLine

(
  • startPoint
  • endPoint
  • line
)
private

Inherited from Axis: charts/js/Axis.js:319

Draws a line segment between 2 points

Parameters:

  • startPoint Object

    x and y coordinates for the start point of the line segment

  • endPoint Object

    x and y coordinates for the for the end point of the line segment

  • line Object

    styles (weight, color and alpha to be applied to the line segment)

drawTick

(
  • path
  • pt
  • tickStyles
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:90

Draws a tick

Parameters:

  • path Path

    reference to the path Path element in which to draw the tick.

  • pt Object

    hash containing x and y coordinates

  • tickStyles Object

    hash of properties used to draw the tick

enable

() chainable

Inherited from Widget: widget/js/Widget.js:683

Set the Widget's "disabled" attribute to "false".

fire

(
  • type
  • arguments
)
EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:695

Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.

If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.

Parameters:

  • type String | Object

    The type of the event, or an object that contains a 'type' property.

  • arguments Object*

    an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.

Returns:

EventTarget: the event host

focus

() chainable

Inherited from Widget: widget/js/Widget.js:663

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

formatLabel

(
  • value
  • format
)

Inherited from TimeImpl: charts/js/TimeImpl.js:150

Formats a label based on the axis type and optionally specified format.

Parameters:

  • value Object
  • format Object

    Pattern used to format the value.

Returns:

String

get

(
  • name
)
Any

Inherited from AttributeCore: attribute/js/AttributeCore.js:353

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

  • name String

    The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))

Returns:

Any: The value of the attribute

getAttrs

(
  • attrs
)
Object

Inherited from AttributeCore: attribute/js/AttributeCore.js:762

Gets multiple attribute values.

Parameters:

  • attrs Array | boolean

    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

getClassName

(
  • args
)

Inherited from Widget but overwritten in widget/js/Widget.js:309

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the Y.config.classNamePrefix attribute used by ClassNameManager and Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name).

The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.

Parameters:

  • args String* multiple

    0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name

getDataByKey

(
  • value
)

Inherited from AxisBase: charts/js/AxisBase.js:234

Returns values based on key identifiers. When a string is passed as an argument, an array of values is returned. When an array of keys is passed as an argument, an object literal with an array of values mapped to each key is returned.

Parameters:

  • value String | Array

    value used to identify the array

Returns:

Array|Object

getDefaultLocale

() String

Inherited from Widget: widget/js/WidgetLocale.js:153

Returns the default locale for the widget (the locale value defined by the widget class, or provided by the user during construction).

Returns:

String: The default locale for the widget

getEdgeOffset

(
  • ct
  • l
)

Inherited from AxisBase: charts/js/AxisBase.js:288

Gets the distance that the first and last ticks are offset from there respective edges.

Parameters:

  • ct Number

    Number of ticks on the axis.

  • l Number

    Length (in pixels) of the axis.

Returns:

Number

getEvent

(
  • type
  • prefixed
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:814

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

  • type String

    the type, or name of the event

  • prefixed String

    if true, the type is prefixed already

Returns:

CustomEvent: the custom event or null

getExplicitlySized

() protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:154

Determines the available label height when the axis width has been explicitly set.

Returns:

Boolean

getFirstPoint

(
  • pt
)
private

Inherited from Axis: charts/js/Axis.js:832

Gets the position of the first point on an axis.

Parameters:

  • pt Object

    Object containing x and y coordinates.

Returns:

Object

getKeyValueAt

(
  • key
  • index
)

Inherited from AxisBase: charts/js/AxisBase.js:215

Returns a value based of a key value and an index.

Parameters:

  • key String

    value used to look up the correct array

  • index Number

    within the array

Returns:

Number

getLabel

(
  • pt
  • styles
)
private

Inherited from Axis: charts/js/Axis.js:689

Creates or updates an axis label.

Parameters:

  • pt Object

    x and y coordinates for the label

  • styles Object

    styles applied to label

Returns:

HTMLElement

getLabelByIndex

(
  • i
  • l
)

Inherited from Axis: charts/js/Axis.js:22

Calculates and returns a value based on the number of labels and the index of the current label.

Parameters:

  • i Number

    Index of the label.

  • l Number

    Total number of labels.

Returns:

String

getLabelPoint

(
  • pt
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:110

Calculates the point for a label.

Parameters:

  • pt Object

    Object containing x and y coordinates

Returns:

Object

getLength

() private

Inherited from Axis: charts/js/Axis.js:806

Calcuates the width or height of an axis depending on its direction.

Returns:

Number

getLineEnd

() private

Inherited from Axis: charts/js/Axis.js:784

Gets the end point of an axis.

Returns:

Object

getLineStart

() protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:65

Calculates the coordinates for the first point on an axis.

getMajorUnitDistance

(
  • len
  • uiLen
  • majorUnit
)

Inherited from Axis: charts/js/Axis.js:1156

Returns the distance between major units on an axis.

Parameters:

  • len Number

    Number of ticks

  • uiLen Number

    Size of the axis.

  • majorUnit Object

    Hash of properties used to determine the majorUnit

Returns:

Number

getMaximumValue

()

Inherited from Axis: charts/js/Axis.js:1213

Returns a string corresponding to the last label on an axis.

Returns:

String

getMaxLabelBounds

()

Inherited from Axis: charts/js/Axis.js:995

Returns the coordinates (top, right, bottom, left) for the bounding box of the last label.

Returns:

Object

getMinimumValue

()

Inherited from Axis: charts/js/Axis.js:1201

Returns a string corresponding to the first label on an axis.

Returns:

String

getMinLabelBounds

()

Inherited from Axis: charts/js/Axis.js:1006

Returns the coordinates (top, right, bottom, left) for the bounding box of the first label.

Returns:

Object

getSkinName

(
  • [skinPrefix]
)
String

Inherited from Widget: widget/js/WidgetSkin.js:12

Returns the name of the skin that's currently applied to the widget.

Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.

This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.

Parameters:

  • [skinPrefix] String optional

    The prefix which the implementation uses for the skin ("yui3-skin-" is the default).

    NOTE: skinPrefix will be used as part of a regular expression:

    new RegExp('\\b' + skinPrefix + '(\\S+)')

    Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.

Returns:

String: The name of the skin, or null, if a matching skin class is not found.

getString

(
  • key
)
String deprecated

Inherited from Widget but overwritten in widget/js/Widget.js:1225

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

Parameters:

Returns:

String: The string

getStrings

(
  • key
)
String deprecated

Inherited from Widget but overwritten in widget/js/Widget.js:1237

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

Parameters:

Returns:

String: The strings

getTargets

()

Inherited from EventTarget: event-custom/js/event-facade.js:479

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

getTotalMajorUnits

()

Inherited from AxisBase but overwritten in charts/js/Axis.js:1134

Returns the total number of majorUnits that will appear on an axis.

Returns:

Number

hide

() chainable

Inherited from Widget: widget/js/Widget.js:645

Hides the Widget by setting the "visible" attribute to "false".

init

(
  • cfg
)
BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:264

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

  • cfg Object

    Object with configuration property name/value pairs

Returns:

BaseCore: A reference to this object

initializer

() private

Inherited from Widget but overwritten in charts/js/AxisBase.js:28

isRoot

() Boolean

Inherited from Widget: widget-child/js/Widget-Child.js:267

Determines if the Widget is the root Widget in the object hierarchy.

Returns:

Boolean: Boolean indicating if Widget is the root Widget in the object hierarchy.

modifyAttr

(
  • name
  • config
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:40

Updates the configuration of an attribute which has already been added.

The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: readOnly, writeOnce, broadcast and getter.

Parameters:

  • name String

    The name of the attribute whose configuration is to be updated.

  • config Object

    An object with configuration property/value pairs, specifying the configuration properties to modify.

next

(
  • circular
)
Widget

Inherited from Widget: widget-child/js/Widget-Child.js:191

Returns the Widget's next sibling.

Parameters:

  • circular Boolean

    Boolean indicating if the parent's first child should be returned if the child has no next sibling.

Returns:

Widget: Widget instance.

offsetNodeForTick

(
  • cb
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:316

Adjusts position for inner ticks.

Parameters:

  • cb Node

    contentBox of the axis

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:188

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the behavior published to that event's defaultFn. See the EventFacade API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() after the event name.

To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.

Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:124

Listen to a custom event hosted by this object one time. This is the equivalent to on except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:146

Listen to a custom event hosted by this object one time. This is the equivalent to after except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

parseType

(
  • type
  • [pre=this._yuievt.config.prefix]
)
Array

Inherited from EventTarget: event-custom/js/event-target.js:168

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

  • type String

    the type

  • [pre=this._yuievt.config.prefix] String optional

    the prefix

Returns:

Array: an array containing: * the detach category, if supplied, * the prefixed event type, * whether or not this is an after listener, * the supplied event type

positionLabel

(
  • label
  • pt
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:206

Rotate and position labels.

Parameters:

  • label HTMLElement

    to rotate position

  • pt Object

    hash containing the x and y coordinates in which the label will be positioned against.

positionTitle

(
  • label
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:176

Rotate and position title.

Parameters:

previous

(
  • circular
)
Widget

Inherited from Widget: widget-child/js/Widget-Child.js:216

Returns the Widget's previous sibling.

Parameters:

  • circular Boolean

    Boolean indicating if the parent's last child should be returned if the child has no previous sibling.

Returns:

Widget: Widget instance.

publish

(
  • type
  • opts
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:493

Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.

Parameters:

  • type String

    the type, or name of the event

  • opts Object

    optional config params. Valid properties are:

    • 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
    • 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
    • 'context': the default execution context for the listeners (this)
    • 'defaultFn': the default function to execute when this event fires if preventDefault was not called
    • 'emitFacade': whether or not this event emits a facade (false)
    • 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
    • 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
    • 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
    • 'preventable': whether or not preventDefault() has an effect (true)
    • 'preventedFn': a function that is executed when preventDefault is called
    • 'queuable': whether or not this event can be queued during bubbling (false)
    • 'silent': if silent is true, debug messages are not provided for this event.
    • 'stoppedFn': a function that is executed when stopPropagation is called

    • 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
    • 'type': the event type (valid option if not provided as the first parameter to publish)

Returns:

CustomEvent: the custom event

removeAttr

(
  • name
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:79

Removes an attribute from the host object

Parameters:

  • name String

    The name of the attribute to be removed.

removeKey

(
  • value
)

Inherited from AxisBase: charts/js/AxisBase.js:198

Removes an array from the key hash.

Parameters:

  • value String

    Indicates what key to use in removing from the hash.

removeTarget

(
  • o
)

Inherited from EventTarget: event-custom/js/event-facade.js:489

Removes a bubble target

Parameters:

render

(
  • parentNode
)
final chainable

Inherited from Widget: widget/js/Widget.js:513

Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case).

This method should only be invoked once for an initialized widget.

It delegates to the widget specific renderer method to do the actual work.

Parameters:

  • parentNode Object | String

    Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.

    If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.

renderer

() protected

Inherited from Widget: widget/js/Widget.js:588

Creates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.

renderUI

() private

Inherited from Widget but overwritten in charts/js/Axis.js:141

reset

(
  • name
)
Object chainable

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:89

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

  • name String

    Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object: A reference to the host object.

set

(
  • name
  • value
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:410

Sets the value of an attribute.

Parameters:

  • name String

    The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. set("x.y.z", 5)).

  • value Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

setAttrs

(
  • attrs
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:729

Sets multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

setCalculatedSize

() protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:329

Assigns a height based on the size of the contents.

setTickOffset

() protected

Inherited from RightAxisLayout but overwritten in charts/js/LeftAxisLayout.js:43

Sets the length of the tick on either side of the axis line.

setTickOffsets

() protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:28

Sets the length of the tick on either side of the axis line.

show

() chainable

Inherited from Widget: widget/js/Widget.js:654

Shows the Widget by setting the "visible" attribute to "true".

subscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:336

Deprecated: use on

subscribe to an event

syncUI

() private

Inherited from Widget but overwritten in charts/js/Axis.js:150

toString

() String

Inherited from BaseCore but overwritten in widget/js/Widget.js:1107

Generic toString implementation for all widgets.

Returns:

String: The default string value for the widget [ displays the NAME of the instance, and the unique id ]

unsubscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:459

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: event-custom/js/event-target.js:480

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

updateMaxLabelSize

(
  • label
)
protected

Inherited from TopAxisLayout but overwritten in charts/js/BottomAxisLayout.js:123

Updates the value for the maxLabelSize for use in calculating total size.

Parameters:

Properties

_allowAdHocAttrs

Boolean protected

Inherited from BaseCore: base/js/BaseCore.js:100

This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.

AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass.NONATTRS_CFG

Default: undefined (false)

_calculatedHeight

Number private

Inherited from Axis: charts/js/Axis.js:63

Storage for calculatedHeight value.

_calculatedWidth

Number private

Inherited from Axis: charts/js/Axis.js:54

Storage for calculatedWidth value.

_data

Array private

Inherited from AxisBase: charts/js/AxisBase.js:114

Reference to data array.

_dataReady

Boolean private

Inherited from AxisBase: charts/js/AxisBase.js:132

Storage for dataReady attribute.

_dataType

Unknown private

Inherited from TimeImpl: charts/js/TimeImpl.js:177

Type of data used in Axis.

_layoutClasses

Object private

Inherited from Axis: charts/js/Axis.js:304

Maps key values to classes containing layout algorithms

_setMaximum

Object private

Inherited from AxisBase: charts/js/AxisBase.js:96

Storage for setMaximum attribute.

_setMinimum

Object private

Inherited from AxisBase: charts/js/AxisBase.js:105

Storage for setMinimum attribute.

_type

Unknown private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:55

Type of data used in Data.

_UI_ATTRS

Object private

Inherited from Widget: widget/js/Widget.js:1249

The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations

_updateTotalDataFlag

Boolean private

Inherited from AxisBase: charts/js/AxisBase.js:123

Indicates whether the all data is up to date.

BOUNDING_TEMPLATE

String

Inherited from Widget: widget/js/Widget.js:1145

Property defining the markup template for bounding box.

CONTENT_TEMPLATE

String

Inherited from Widget: widget/js/Widget.js:1135

Property defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.

DEF_PARENT_NODE

String | Node

Inherited from Widget: widget/js/Widget.js:1126

Default node to render the bounding box to. If not set, will default to the current document body.

DEF_UNIT

String

Inherited from Widget: widget/js/Widget.js:1118

Default unit to use for dimension values

GUID

String private

Inherited from AxisBase but overwritten in charts/js/TimeImpl.js:168

Constant used to generate unique id.

maxLabelSize

Number protected

Inherited from Axis: charts/js/Axis.js:1098

Length in pixels of largest text bounding box. Used to calculate the height of the axis.

name

String deprecated

Inherited from BaseCore: base/js/BaseCore.js:242

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

UI_EVENTS

Object

Inherited from Widget: widget/js/WidgetUIEvents.js:52

Map of DOM events that should be fired as Custom Events by the Widget instance.

Attributes

appendLabelFunction

Function

Inherited from Axis: charts/js/Axis.js:1550

Function used to append an axis value to an axis label. This function has the following signature:

textField
The axis label to be appended. (HTMLElement)
val
The value to attach to the text field. This method will accept an HTMLELement or a String. This method does not use (HTMLElement | String)
The default method appends a value to the HTMLElement using the appendChild method. If the given value is a String, the method will convert the the value to a textNode before appending to the HTMLElement. This method will not convert an HTMLString to an HTMLElement.

Fires event appendLabelFunctionChange

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

appendTitleFunction

Function

Inherited from Axis: charts/js/Axis.js:1571

Function used to append a title value to the title object. This function has the following signature:

textField
The title text field to be appended. (HTMLElement)
val
The value to attach to the text field. This method will accept an HTMLELement or a String. This method does not use (HTMLElement | String)
The default method appends a value to the HTMLElement using the appendChild method. If the given value is a String, the method will convert the the value to a textNode before appending to the HTMLElement element. This method will not convert an HTMLString to an HTMLElement.

Fires event appendTitleFunctionChange

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

bottomTickOffset

Number

Inherited from Axis: charts/js/Axis.js:1432

Distance determined by the tick styles used to calculate the distance between the axis line in relation to the bottom of the axis.

Fires event bottomTickOffsetChange

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

boundingBox

String | Node

Inherited from Widget: widget/js/Widget.js:175

The outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning.

Fires event boundingBoxChange

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

calculatedHeight

Number private

Inherited from Axis: charts/js/Axis.js:1306

Calculated value of an axis' height. By default, the value is used internally for horizontal axes. If the height attribute is explicitly set, this value will be ignored.

Fires event calculatedHeightChange

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

calculatedWidth

Number private

Inherited from Axis: charts/js/Axis.js:1285

Calculated value of an axis' width. By default, the value is used internally for vertical axes. If the width attribute is explicitly set, this value will be ignored.

Fires event calculatedWidthChange

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

calculateEdgeOffset

Boolean

Inherited from AxisBase: charts/js/AxisBase.js:434

Determines whether and offset is automatically calculated for the edges of the axis.

Fires event calculateEdgeOffsetChange

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

contentBox

String | Node

Inherited from Widget: widget/js/Widget.js:189

A DOM node that is a direct descendant of a Widget's bounding box that houses its content.

Fires event contentBoxChange

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

data

Array

Inherited from AxisBase: charts/js/AxisBase.js:620

Array of axis data

Fires event dataChange

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

dataMaximum

Number

Inherited from AxisBase: charts/js/AxisBase.js:530

The maximum value contained in the data array. Used for maximum when autoMax is true.

Fires event dataMaximumChange

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

dataMinimum

Number

Inherited from AxisBase: charts/js/AxisBase.js:562

The minimum value contained in the data array. Used for minimum when autoMin is true.

Fires event dataMinimumChange

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

dataProvider

Array

Inherited from AxisBase: charts/js/AxisBase.js:516

Instance of ChartDataProvider that the class uses to build its own data.

Fires event dataProviderChange

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

destroyed

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:157

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

Fires event destroyedChange

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

disabled

Boolean

Inherited from Widget: widget/js/Widget.js:231

Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.

Default: false

Fires event disabledChange

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

edgeOffset

Number protected

Inherited from Axis: charts/js/Axis.js:1327

Difference between the first/last tick and edge of axis.

Fires event edgeOffsetChange

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

focused

Boolean readonly

Inherited from Widget: widget/js/Widget.js:218

Boolean indicating if the Widget, or one of its descendants, has focus.

Default: false

Fires event focusedChange

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

graphic

Graphic

Inherited from Axis: charts/js/Axis.js:1339

The graphic in which the axis line and ticks 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.

height

Number

Inherited from Widget but overwritten in charts/js/Axis.js:1256

When set, defines the height of a horizontal axis instance. By default, horizontal axes automatically size based on their contents. When the height attribute is set, the axis will not calculate its height. When the height attribute is explicitly set, axis labels will postion themselves off of the the inner edge of the axis and the title, if present, will position itself off of the outer edge. If a specified height is less than the sum of the axis' contents, excess content will overflow.

Fires event heightChange

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

hideFirstMajorUnit

Boolean

Inherited from Axis: charts/js/Axis.js:1620

Suppresses the creation of the the first visible label and tick.

Fires event hideFirstMajorUnitChange

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

hideLastMajorUnit

Boolean

Inherited from Axis: charts/js/Axis.js:1630

Suppresses the creation of the the last visible label and tick.

Fires event hideLastMajorUnitChange

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

id

String

Inherited from Widget: widget/js/Widget.js:149

Default: Generated using guid()

Fires event idChange

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

initialized

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:143

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

Fires event initializedChange

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

keyCollection

Array

Inherited from AxisBase: charts/js/AxisBase.js:637

Array containing all the keys in the axis.

Fires event keyCollectionChange

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

keys

Object

Inherited from AxisBase: charts/js/AxisBase.js:450

Hash of array identifed by a string value.

Fires event keysChange

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

labelFormat

String

Inherited from TimeImpl: charts/js/TimeImpl.js:43

Pattern used by the labelFunction to format a label.

Fires event labelFormatChange

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

labelFunction

Function

Inherited from TimeImpl: charts/js/TimeImpl.js:28

Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need to implement the arguments below and return a String or an HTMLElement. The default implementation of the method returns a String. The output of this method will be rendered to the DOM using appendChild. If you override the labelFunction method and return an html string, you will also need to override the Axis' appendLabelFunction to accept html as a String.

val
Label to be formatted. (String)
format
STRFTime string used to format the label. (optional)

Fires event labelFunctionChange

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

labelFunctionScope

Object

Inherited from AxisBase: charts/js/AxisBase.js:661

Object which should have by the labelFunction

Fires event labelFunctionScopeChange

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

labels

Array

Inherited from Axis: charts/js/Axis.js:1465

Collection of labels used to render the axis.

Fires event labelsChange

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

labelValues

Array

Inherited from Axis: charts/js/Axis.js:1592

An array containing the unformatted values of the axis labels. By default, TimeAxis, NumericAxis and StackedAxis labelValues are determined by the majorUnit style. By default, CategoryAxis labels are determined by the values of the dataProvider.

When the labelValues attribute is explicitly set, the labelValues are dictated by the set value and the position of ticks and labels are determined by where those values would fall on the axis.

Fires event labelValuesChange

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

leftTickOffset

Number

Inherited from Axis: charts/js/Axis.js:1443

Distance determined by the tick styles used to calculate the distance between the axis line in relation to the left of the axis.

Fires event leftTickOffsetChange

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

locale

String deprecated

Inherited from Widget: widget/js/WidgetLocale.js:17

Deprecated: Use Y.config.lang and Y.Intl externalization support

The default locale for the widget. NOTE: Using get/set on the "strings" attribute will return/set strings for this locale.

Default: "en"

Fires event localeChange

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

maximum

Number

Inherited from AxisBase: charts/js/AxisBase.js:548

The maximum value that will appear on an axis.

Fires event maximumChange

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

maxLabelSize

Number protected

Inherited from Axis: charts/js/Axis.js:1514

Length in pixels of largest text bounding box. Used to calculate the height of the axis.

Fires event maxLabelSizeChange

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

minimum

Number

Inherited from AxisBase: charts/js/AxisBase.js:580

The minimum value that will appear on an axis.

Fires event minimumChange

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

node

HTMLElement

Inherited from Axis: charts/js/Axis.js:1393

Contains the contents of the axis.

Fires event nodeChange

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

overlapGraph

Boolean

Inherited from Axis: charts/js/Axis.js:1498

Indicates whether the axis overlaps the graph. If an axis is the inner most axis on a given position and the tick position is inside or cross, the axis will need to overlap the graph.

Fires event overlapGraphChange

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

path

Shape private readonly

Inherited from Axis: charts/js/Axis.js:1347

Fires event pathChange

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

position

String

Inherited from Axis: charts/js/Axis.js:1401

Direction of the axis.

Fires event positionChange

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

render

Boolean | Node

Inherited from Widget: widget/js/Widget.js:286

Whether or not to render the widget automatically after init, and optionally, to which parent node.

Fires event renderChange

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

rendered

Boolean readonly

Inherited from Widget: widget/js/Widget.js:161

Flag indicating whether or not this Widget has been through the render lifecycle phase.

Default: false

Fires event renderedChange

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

rightTickOffset

Number

Inherited from Axis: charts/js/Axis.js:1454

Distance determined by the tick styles used to calculate the distance between the axis line in relation to the right side of the axis.

Fires event rightTickOffsetChange

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

setMax

Boolean

Inherited from AxisBase: charts/js/AxisBase.js:594

Determines whether the maximum is calculated or explicitly set by the user.

Fires event setMaxChange

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

setMin

Boolean

Inherited from AxisBase: charts/js/AxisBase.js:607

Determines whether the minimum is calculated or explicitly set by the user.

Fires event setMinChange

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

srcNode

String | Node

Inherited from Widget: widget/js/WidgetHTMLParser.js:58

The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition

Fires event srcNodeChange

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

strings

Object

Inherited from Widget: widget/js/Widget.js:274

Collection of strings used to label elements of the Widget's UI.

Default: null

Fires event stringsChange

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

Inherited from Axis: charts/js/Axis.js:1640

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

majorTicks
Properties used for drawing ticks.
display
Position of the tick. Possible values are inside, outside, cross and none. The default value is inside.
length
The length (in pixels) of the tick. The default value is 4.
color
The color of the tick. The default value is #dad8c9
weight
Number indicating the width of the tick. The default value is 1.
alpha
Number from 0 to 1 indicating the opacity of the tick. The default value is 1.
line
Properties used for drawing the axis line.
weight
Number indicating the width of the axis line. The default value is 1.
color
The color of the axis line. The default value is #dad8c9.
alpha
Number from 0 to 1 indicating the opacity of the tick. The default value is 1.
majorUnit
Properties used to calculate the majorUnit for the axis.
determinant
The algorithm used for calculating distance between ticks. The possible options are count and distance. If the determinant is count, the axis ticks will spaced so that a specified number of ticks appear on the axis. If the determinant is distance, the axis ticks will spaced out according to the specified distance. The default value is count.
count
Number of ticks to appear on the axis when the determinant is count. The default value is 11.
distance
The distance (in pixels) between ticks when the determinant is distance. The default value is 75.
label
Properties and styles applied to the axis labels.
color
The color of the labels. The default value is #808080.
alpha
Number between 0 and 1 indicating the opacity of the labels. The default value is 1.
fontSize
The font-size of the labels. The default value is 85%
rotation
The rotation, in degrees (between -90 and 90) of the labels. The default value is 0.
margin
The distance between the label and the axis/tick. Depending on the position of the Axis, only one of the properties used.
top
Pixel value used for an axis with a position of bottom. The default value is 4.
right
Pixel value used for an axis with a position of left. The default value is 4.
bottom
Pixel value used for an axis with a position of top. The default value is 4.
left
Pixel value used for an axis with a position of right. The default value is 4.

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.

tabIndex

Number

Inherited from Widget: widget/js/Widget.js:202

Number (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box.

Default: null

Fires event tabIndexChange

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

tickPath

Shape private readonly

Inherited from Axis: charts/js/Axis.js:1370

Fires event tickPathChange

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

tickPoints

Array

Inherited from Axis: charts/js/Axis.js:1479

Collection of points used for placement of labels and ticks along the axis.

Fires event tickPointsChange

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

title

String

Inherited from Axis: charts/js/Axis.js:1534

Title for the axis. When specified, the title will display. The position of the title is determined by the axis position.

top
Appears above the axis and it labels. The default rotation is 0.
right
Appears to the right of the axis and its labels. The default rotation is 90.
bottom
Appears below the axis and its labels. The default rotation is 0.
left
Appears to the left of the axis and its labels. The default rotation is -90.

Fires event titleChange

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

topTickOffset

Number

Inherited from Axis: charts/js/Axis.js:1421

Distance determined by the tick styles used to calculate the distance between the axis line in relation to the top of the axis.

Fires event topTickOffsetChange

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

Inherited from AxisBase: charts/js/AxisBase.js:494

Returns the type of axis data

time
Manages time data
stacked
Manages stacked numeric data
numeric
Manages numeric data
category
Manages categorical data

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.

visible

Boolean

Inherited from Widget: widget/js/Widget.js:242

Boolean indicating whether or not the Widget is visible.

Default: TRUE

Fires event visibleChange

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

width

Number

Inherited from Widget but overwritten in charts/js/Axis.js:1227

When set, defines the width of a vertical axis instance. By default, vertical axes automatically size based on their contents. When the width attribute is set, the axis will not calculate its width. When the width attribute is explicitly set, axis labels will postion themselves off of the the inner edge of the axis and the title, if present, will position itself off of the outer edge. If a specified width is less than the sum of the axis' contents, excess content will overflow.

Fires event widthChange

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

Events

destroy

Inherited from BaseObservable: base/js/BaseObservable.js:151

Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.

Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).

Event Payload:

init

Inherited from BaseObservable: base/js/BaseObservable.js:62

Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.

Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

Event Payload:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.

render

Inherited from Widget: widget/js/Widget.js:543

Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method).

Subscribers to the "on" moment of this event, will be notified before the widget is rendered.

Subscribers to the "after" moment of this event, will be notified after rendering is complete.

Event Payload:

widget:contentUpdate

Inherited from Widget: widget/js/Widget.js:397

Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners).

Event Payload: