CandlestickSeries Class
+ + + + +The CandlestickSeries class renders columns (candles) and lines (wicks) representing the open, high, low and close +values for a chart.
+Constructor
+CandlestickSeries
+
+
+ -
+
+
-
+
+
config+ +
+
+
Parameters:
+ +-
+
+
-
+
+
config+ Object + + + + +++ + +(optional) Configuration parameters.
+
+
+
-
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
- Events + +
Item Index
+ + +Methods
+ +-
+
+
- + _getAttrInitVal + + + + + +
- + + + + + + +
- + destructor + + + + + +
- + _getDefaultStyles + + + + + +
- + drawSeries + + + + + +
- + addListeners + + + + + +
- + _xAxisChangeHandler + + + + + +
- + _yAxisChangeHandler + + + + + +
- + _xDataChangeHandler + + + + + +
- + _yDataChangeHandler + + + + + +
- + _updateAxisBase + + + + + +
- + _checkForDataByKey + + + + + +
- + validate + + + + + +
- + setAreaData + + + + + +
- + _copyData + + + + + +
- + _setXMarkerPlane + + + + + +
- + _setYMarkerPlane + + + + + +
- + _getXCoords + + + + + +
- + _getYCoords + + + + + +
- + _getFirstValidIndex + + + + + +
- + _getLastValidIndex + + + + + +
- + draw + + + + + +
- + render + + + + + +
- + _setCanvas + + + + + +
- + _getChart + + + + + +
- + getTotalValues + + + + + +
- + _handleVisibleChange + + + + + +
- + _getDefaultColor + + + + + +
- + _setStyles + + + + + +
- + _mergeStyles + + + + + +
- + _initAttrHost + + + + + +
- + addAttr + + + + + +
- + attrAdded + + + + + +
- + get + + + + + +
- + _isLazyAttr + + + + + +
- + _addLazyAttr + + + + + +
- + set + + + + + +
- + _set + + + + + +
- + _setAttr + + + + + +
- + _getAttr + + + + + +
- + _getStateVal + + + + + +
- + _setStateVal + + + + + +
- + _setAttrVal + + + + + +
- + setAttrs + + + + + +
- + _setAttrs + + + + + +
- + getAttrs + + + + + +
- + _getAttrs + + + + + +
- + addAttrs + + + + + +
- + _addAttrs + + + + + +
- + _protectAttrs + + + + deprecated + + + +
- + _normAttrVals + + + + + +
- + _toggleVisible + + + + + +
- + _initAttrs + + + + + +
- + modifyAttr + + + + + +
- + removeAttr + + + + + +
- + reset + + + + + +
- + _getAttrCfg + + + + + +
- + _fireAttrChange + + + + + +
- + _defAttrChangeFn + + + + + +
- + _initBase + + + + + +
- + _initAttribute + + + + + +
- + init + + + + + +
- + _baseInit + + + + + +
- + destroy + + + + + +
- + _baseDestroy + + + + + +
- + _getClasses + + + + + +
- + _getAttrCfgs + + + + + +
- + _filterAttrCfgs + + + + + +
- + _filterAdHocAttrs + + + + + +
- + _initHierarchyData + + + + + +
- + _attrCfgHash + + + + + +
- + _cloneDefaultValue + + + + + +
- + _aggregateAttrs + + + + + +
- + _initHierarchy + + + + + +
- + _destroyHierarchy + + + + + +
- + toString + + + + + +
- + _preInitEventCfg + + + + + +
- + _defInitFn + + + + + +
- + _defDestroyFn + + + + + +
- + addTarget + + + + + +
- + getTargets + + + + + +
- + removeTarget + + + + + +
- + bubble + + + + + +
- + _getType + + + + + +
- + _parseType + + + + + +
- + once + + + + + +
- + onceAfter + + + + + +
- + parseType + + + + + +
- + on + + + + + +
- + subscribe + + + + deprecated + + + +
- + detach + + + + + +
- + unsubscribe + + + + deprecated + + + +
- + detachAll + + + + + +
- + unsubscribeAll + + + + deprecated + + + +
- + publish + + + + + +
- + _getFullType + + + + + +
- + _publish + + + + + +
- + _monitor + + + + + +
- + fire + + + + + +
- + getEvent + + + + + +
- + after + + + + + +
- + before + + + + + +
Properties
+ +-
+
+
- + _allowAdHocAttrs + + + + + +
- + _bottomOrigin + + + + + +
- + _defaultBorderColors + + + + + +
- + _defaultFillColors + + + + + +
- + _defaultLineColors + + + + + +
- + _defaultPlaneOffset + + + + + +
- + _defaultSliceColors + + + + + +
- + _heightChangeHandle + + + + + +
- + _leftOrigin + + + + + +
- + _styles + + + + + +
- + _stylesChangeHandle + + + + + +
- + _visibleChangeHandle + + + + + +
- + _widthChangeHandle + + + + + +
- + _xAxisChangeHandle + + + + + +
- + _xDataReadyHandle + + + + + +
- + _xDataUpdateHandle + + + + + +
- + _xDisplayName + + + + + +
- + _yAxisChangeHandle + + + + + +
- + _yDataReadyHandle + + + + + +
- + _yDataUpdateHandle + + + + + +
- + _yDisplayName + + + + + +
- + GUID + + + + + +
- + name + + + + deprecated + + + +
Attributes
+ +-
+
+
- + categoryDisplayName + + +
- + chart + + +
- + destroyed + + +
- + direction + + +
- + downcandle + + +
- + graph + + +
- + graphic + + +
- + graphOrder + + +
- + groupMarkers + + +
- + height + + +
- + initialized + + +
- + ohlc + + +
- + order + + +
- + rendered + + +
- + seriesTypeCollection + + +
- + styles + + +
- + type + + +
- + upcandle + + +
- + valueDisplayName + + +
- + visible + + +
- + wick + + +
- + xAxis + + +
- + xcoords + + +
- + xData + + +
- + xDisplayName + + +
- + xKey + + +
- + xMarkerPlane + + +
- + xMarkerPlaneOffset + + +
- + yAxis + + +
- + ycoords + + +
- + yData + + +
- + yDisplayName + + +
- + yKey + + +
- + yMarkerPlane + + +
- + yMarkerPlaneOffset + + +
Methods
+ + +_getAttrInitVal
+
+
+ -
+
+
-
+
+
attr+ +
+
+ -
+
+
cfg+ +
+
+ -
+
+
initValues+ +
+
+
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:
+ + +Returns:
+ +-
+
+
-
+
+
xcoords+ +
+
+ -
+
+
opencoords+ +
+
+ -
+
+
highcoords+ +
+
+ -
+
+
lowcoords+ +
+
+ -
+
+
closecoords+ +
+
+ -
+
+
len+ +
+
+ -
+
+
width+ +
+
+ -
+
+
halfwidth+ +
+
+ -
+
+
styles+ +
+
+
Draws markers for an Candlestick series.
+Parameters:
+ +-
+
+
-
+
+
xcoords+ Array + + + + +++ + +The xcoordinates to be plotted.
+
+
+ -
+
+
opencoords+ Array + + + + +++ + +The coordinates representing the open values.
+
+
+ -
+
+
highcoords+ Array + + + + +++ + +The coordinates representing the high values.
+
+
+ -
+
+
lowcoords+ Array + + + + +++ + +The coordinates representing the low values.
+
+
+ -
+
+
closecoords+ Array + + + + +++ + +The coordinates representing the close values.
+
+
+ -
+
+
len+ Number + + + + +++ + +The number of x coordinates to plot.
+
+
+ -
+
+
width+ Number + + + + +++ + +The width of each candlestick marker.
+
+
+ -
+
+
halfwidth+ Number + + + + +++ + +Half the width of each candlestick marker.
+
+
+ -
+
+
styles+ Object + + + + +++ + +The styles for the series.
+
+
+
destructor
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Destructor implementation for the CartesianSeries class. Calls destroy on all Graphic instances.
+_getDefaultStyles
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Gets the default value for the styles attribute. Overrides
+base implementation.
Returns:
+ +drawSeries
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Draws the series.
+addListeners
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds event listeners.
+_xAxisChangeHandler
+
+
+ -
+
+
-
+
+
e+ +
+
+
Event handler for the xAxisChange event.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_yAxisChangeHandler
+
+
+ -
+
+
-
+
+
e+ +
+
+
Event handler the yAxisChange event.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_xDataChangeHandler
+
+
+ -
+
+
-
+
+
event+ +
+
+
Event handler for xDataChange event.
+Parameters:
+ +-
+
+
-
+
+
event+ Object + + + + +++ + +Event object.
+
+
+
_yDataChangeHandler
+
+
+ -
+
+
-
+
+
event+ +
+
+
Event handler for yDataChange event.
+Parameters:
+ +-
+
+
-
+
+
event+ Object + + + + +++ + +Event object.
+
+
+
_updateAxisBase
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Checks to ensure that both xAxis and yAxis data are available. If so, set the xData and yData attributes
+and return true. Otherwise, return false.
Returns:
+ +_checkForDataByKey
+
+
+ -
+
+
-
+
+
obj+ +
+
+ -
+
+
keys+ +
+
+
Checks to see if all keys of a data object exist and contain data.
+Parameters:
+ + +Returns:
+ +validate
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Draws the series is the xAxis and yAxis data are both available.
+setAreaData
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Calculates the coordinates for the series.
+_copyData
+
+
+ -
+
+
-
+
+
val+ +
+
+
Used to cache xData and yData in the setAreaData method. Returns a copy of an +array if an array is received as the param and returns an object literal of +array copies if an object literal is received as the param.
+Parameters:
+ + +Returns:
+ +_setXMarkerPlane
+
+
+ -
+
+
-
+
+
coords+ +
+
+ -
+
+
dataLength+ +
+
+
Sets the marker plane for the series when the coords argument is an array. +If the coords argument is an object literal no marker plane is set.
+_setYMarkerPlane
+
+
+ -
+
+
-
+
+
coords+ +
+
+ -
+
+
dataLength+ +
+
+
Sets the marker plane for the series when the coords argument is an array. +If the coords argument is an object literal no marker plane is set.
+_getXCoords
+
+
+ -
+
+
-
+
+
xData+ +
+
+ -
+
+
xMin+ +
+
+ -
+
+
dataWidth+ +
+
+ -
+
+
xScaleFactor+ +
+
+ -
+
+
xOffset+ +
+
+ -
+
+
dataLength+ +
+
+ -
+
+
leftPadding+ +
+
+
Gets the x-coordinates for a series. Used by the setAreaData method. +Returns an array when an array is received as the first argument. +Returns an object literal when an object literal is received as the first argument.
+Parameters:
+ +-
+
+
-
+
+
xData+ Array | Object + + + + +++ + +An array of data values mapped to the x axis or an +object literal containing key values pairs of data values mapped to the x axis.
+
+
+ -
+
+
xMin+ Number + + + + +++ + +The minimum value of the x axis.
+
+
+ -
+
+
dataWidth+ Number + + + + +++ + +The width used to calculate the x-coordinates.
+
+
+ -
+
+
xScaleFactor+ Number + + + + +++ + +The ratio used to calculate x-coordinates.
+
+
+ -
+
+
xOffset+ Number + + + + +++ + +The distance of the first and last x-coordinate from the +beginning and end of the x-axis.
+
+
+ -
+
+
dataLength+ Number + + + + +++ + +The number of data points in the arrays.
+
+
+ -
+
+
leftPadding+ Number + + + + +++ + +The left padding of the series.
+
+
+
Returns:
+ +_getYCoords
+
+
+ -
+
+
-
+
+
yData+ +
+
+ -
+
+
yMin+ +
+
+ -
+
+
dataHeight+ +
+
+ -
+
+
yScaleFactor+ +
+
+ -
+
+
yOffset+ +
+
+ -
+
+
dataLength+ +
+
+ -
+
+
topPadding+ +
+
+
Gets the y-coordinates for a series. Used by the setAreaData method. +Returns an array when an array is received as the first argument. +Returns an object literal when an object literal is received as the first argument.
+Parameters:
+ +-
+
+
-
+
+
yData+ Array | Object + + + + +++ + +An array of data values mapped to the y axis or an +object literal containing key values pairs of data values mapped to the y axis.
+
+
+ -
+
+
yMin+ Number + + + + +++ + +The minimum value of the y axis.
+
+
+ -
+
+
dataHeight+ Number + + + + +++ + +The height used to calculate the y-coordinates.
+
+
+ -
+
+
yScaleFactor+ Number + + + + +++ + +The ratio used to calculate y-coordinates.
+
+
+ -
+
+
yOffset+ Number + + + + +++ + +The distance of the first and last y-coordinate from the beginning and end of the y-axis.
+
+
+ -
+
+
dataLength+ Number + + + + +++ + +The number of data points in the arrays.
+
+
+ -
+
+
topPadding+ Number + + + + +++ + +The top padding of the series.
+
+
+
Returns:
+ +_getFirstValidIndex
+
+
+ -
+
+
-
+
+
coords+ +
+
+
Finds the first valid index of an array coordinates.
+Parameters:
+ +-
+
+
-
+
+
coords+ Array + + + + +++ + +An array of x or y coordinates.
+
+
+
Returns:
+ +_getLastValidIndex
+
+
+ -
+
+
-
+
+
coords+ +
+
+
Finds the last valid index of an array coordinates.
+Parameters:
+ +-
+
+
-
+
+
coords+ Array + + + + +++ + +An array of x or y coordinates.
+
+
+
Returns:
+ +draw
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Draws the series.
+render
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ _setCanvas
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates a Graphic instance.
_getChart
+
+
+ ()
+
+
+
+
+ Object
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns a reference to the parent container to which all chart elements are contained.
+When the series is bound to a Chart instance, the Chart instance is the reference.
+If nothing is set as the chart attribute, the _getChart method will return a reference
+to the graphic attribute.
Returns:
+ +getTotalValues
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the sum of all values for the series.
+Returns:
+ +_handleVisibleChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Shows/hides contents of the series.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_getDefaultColor
+
+
+ -
+
+
-
+
+
index+ +
+
+ -
+
+
type+ +
+
+
Parses a color based on a series order and type.
+Parameters:
+ + +Returns:
+ +_setStyles
+
+
+ -
+
+
-
+
+
newStyles+ +
+
+
Method used by styles setter.
Parameters:
+ +-
+
+
-
+
+
newStyles+ Object + + + + +++ + +Hash of properties to update.
+
+
+
Returns:
+ +_mergeStyles
+
+
+ -
+
+
-
+
+
a+ +
+
+ -
+
+
b+ +
+
+
Merges to object literals so that only specified properties are +overwritten.
+Parameters:
+ + +Returns:
+ +_initAttrHost
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
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).
+
+
+
addAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
config+ +
+
+ -
+
+
lazy+ +
+
+
+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:
+ +attrAdded
+
+
+ -
+
+
-
+
+
name+ +
+
+
Checks if the given attribute has been added to the host
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute to check.
+
+
+
Returns:
+ +get
+
+
+ -
+
+
-
+
+
name+ +
+
+
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:
+ +_isLazyAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+
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:
+ +_addLazyAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
[lazyCfg]+ +
+
+
Finishes initializing an attribute which has been lazily added.
+Parameters:
+ + +set
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+ -
+
+
[opts]+ +
+
+
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:
+ +_set
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
val+ +
+
+ -
+
+
[opts]+ +
+
+
Allows setting of readOnly/writeOnce attributes. See set for argument details.
+Parameters:
+ + +Returns:
+ +_setAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+ -
+
+
[opts]+ +
+
+ -
+
+
force+ +
+
+
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:
+ +_getAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+
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:
+ +_getStateVal
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
[cfg]+ +
+
+
Gets the stored value for the attribute, from either the +internal state object, or the state proxy if it exits
+Parameters:
+ + +Returns:
+ +_setStateVal
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+
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
+
+
+
_setAttrVal
+
+
+ -
+
+
-
+
+
attrName+ +
+
+ -
+
+
subAttrName+ +
+
+ -
+
+
prevVal+ +
+
+ -
+
+
newVal+ +
+
+ -
+
+
[opts]+ +
+
+ -
+
+
[attrCfg]+ +
+
+
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:
+ +setAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
[opts]+ +
+
+
Sets multiple attribute values.
+Parameters:
+ + +Returns:
+ +_setAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
[opts]+ +
+
+
Implementation behind the public setAttrs method, to set multiple attribute values.
+Parameters:
+ + +Returns:
+ +getAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
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:
+ +_getAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
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:
+ +addAttrs
+
+
+ -
+
+
-
+
+
cfgs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
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:
+ +_addAttrs
+
+
+ -
+
+
-
+
+
cfgs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
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.
+
+
+
_protectAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
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:
+ +_normAttrVals
+
+
+ -
+
+
-
+
+
valueHash+ +
+
+
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:
+ +_toggleVisible
+
+
+ -
+
+
-
+
+
visible+ +
+
+
Toggles visibility
+Parameters:
+ +-
+
+
-
+
+
visible+ Boolean + + + + +++ + +indicates visibilitye
+
+
+
_initAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
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).
+
+
+
modifyAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
config+ +
+
+
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. +
+removeAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+
Removes an attribute from the host object
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute to be removed.
+
+
+
reset
+
+
+ -
+
+
-
+
+
name+ +
+
+
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:
+ +_getAttrCfg
+
+
+ -
+
+
-
+
+
name+ +
+
+
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:
+ +_fireAttrChange
+
+
+ -
+
+
-
+
+
attrName+ +
+
+ -
+
+
subAttrName+ +
+
+ -
+
+
currVal+ +
+
+ -
+
+
newVal+ +
+
+ -
+
+
opts+ +
+
+ -
+
+
[cfg]+ +
+
+
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.
+
+
+
_defAttrChangeFn
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default function for attribute change events.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event object for attribute change events.
+
+
+
_initBase
+
+
+ -
+
+
-
+
+
config+ +
+
+
Internal construction logic for BaseCore.
+Parameters:
+ +-
+
+
-
+
+
config+ Object + + + + +++ + +The constructor configuration object
+
+
+
_initAttribute
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes AttributeCore
+init
+
+
+ -
+
+
-
+
+
cfg+ +
+
+
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:
+ +_baseInit
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Internal initialization implementation for BaseCore
+destroy
+
+
+ ()
+
+
+
+
+ BaseCore
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Destroy lifecycle method. Invokes destructors for the class hierarchy.
+Returns:
+ +_baseDestroy
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Internal destroy implementation for BaseCore
+_getClasses
+
+
+ ()
+
+
+
+
+ Function[]
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the class hierarchy for this object, with BaseCore being the last class in the array.
+Returns:
+ +_getAttrCfgs
+
+
+ ()
+
+
+
+
+ Object
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an aggregated set of attribute configurations, by traversing +the class hierarchy.
+Returns:
+ +_filterAttrCfgs
+
+
+ -
+
+
-
+
+
clazz+ +
+
+ -
+
+
allCfgs+ +
+
+
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:
+ +_filterAdHocAttrs
+
+
+ -
+
+
-
+
+
allAttrs+ +
+
+ -
+
+
userVals+ +
+
+
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:
+ +_initHierarchyData
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+_attrCfgHash
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Utility method to define the attribute hash used to filter/whitelist property mixes for +this class for iteration performance reasons.
+_cloneDefaultValue
+
+
+ -
+
+
-
+
+
cfg+ +
+
+
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:
+ +-
+
+
-
+
+
cfg+ Object + + + + ++ ++ + +
+
+
_aggregateAttrs
+
+
+ -
+
+
-
+
+
allAttrs+ +
+
+
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:
+ +_initHierarchy
+
+
+ -
+
+
-
+
+
userVals+ +
+
+
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
+
+
+
_destroyHierarchy
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Destroys the class hierarchy for this instance by invoking +the destructor method on the prototype of each class in the hierarchy.
+toString
+
+
+ ()
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Default toString implementation. Provides the constructor NAME +and the instance guid, if set.
+Returns:
+ +_preInitEventCfg
+
+
+ -
+
+
-
+
+
config+ +
+
+
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
+
+
+
_defInitFn
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default init event handler
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object, with a cfg property which +refers to the configuration object passed to the constructor.
+
+
+
_defDestroyFn
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default destroy event handler
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object
+
+
+
addTarget
+
+
+ -
+
+
-
+
+
o+ +
+
+
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:
+ +-
+
+
-
+
+
o+ EventTarget + + + + +++ + +the target to add
+
+
+
getTargets
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an array of bubble targets for this object.
+Returns:
+ +removeTarget
+
+
+ -
+
+
-
+
+
o+ +
+
+
Removes a bubble target
+Parameters:
+ +-
+
+
-
+
+
o+ EventTarget + + + + +++ + +the target to remove
+
+
+
bubble
+
+
+ -
+
+
-
+
+
evt+ +
+
+
Propagate an event. Requires the event-custom-complex module.
+Parameters:
+ +-
+
+
-
+
+
evt+ CustomEvent + + + + +++ + +the custom event to propagate
+
+
+
Returns:
+ +_getType
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ If the instance has a prefix attribute and the +event type is not prefixed, the instance prefix is +applied to the supplied type.
+_parseType
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an array with the detach key (if provided), +and the prefixed event name from _getType +Y.on('detachcategory| menu:click', fn)
+once
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
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
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +onceAfter
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
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
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +parseType
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
[pre=this._yuievt.config.prefix]+ +
+
+
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:
+ + +Returns:
+ +on
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
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
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +subscribe
+
+
+ ()
+
+
+
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ subscribe to an event
+detach
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
context+ +
+
+
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:
+ +unsubscribe
+
+
+ ()
+
+
+
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ detach a listener
+detachAll
+
+
+ -
+
+
-
+
+
type+ +
+
+
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
+
+
+
unsubscribeAll
+
+
+ -
+
+
-
+
+
type+ +
+
+
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
+
+
+
publish
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
opts+ +
+
+
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:
+ +_getFullType
+
+
+ -
+
+
-
+
+
type+ +
+
+
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:
+ +_publish
+
+
+ -
+
+
-
+
+
fullType+ +
+
+ -
+
+
etOpts+ +
+
+ -
+
+
ceOpts+ +
+
+
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:
+ +etOpts or ceOpts, this will
+be the default CustomEvent instance, and can be configured independently.
+
+ _monitor
+
+
+ -
+
+
-
+
+
what+ +
+
+ -
+
+
eventType+ +
+
+ -
+
+
o+ +
+
+
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
+
+
+
fire
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
arguments+ +
+
+
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:
+ +getEvent
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
prefixed+ +
+
+
Returns the custom event of the provided type has been created, a +falsy value otherwise
+Parameters:
+ + +Returns:
+ +after
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
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
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +before
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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:
+ +Properties
+ + +_allowAdHocAttrs
+ Boolean
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ 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)
+ + + + + +_bottomOrigin
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ The y-coordinate for the bottom edge of the series.
+_defaultBorderColors
+ Array
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ Collection of default colors used for marker borders in a series when not specified by user.
+_defaultFillColors
+ Array
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ Collection of default colors used for marker fills in a series when not specified by user.
+_defaultLineColors
+ Array
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ Collection of default colors used for lines in a series when not specified by user.
+_defaultPlaneOffset
+ Number
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Default value for plane offsets when the parent chart's interactiveType is planar.
_defaultSliceColors
+ Array
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ Collection of default colors used for area fills, histogram fills and pie fills in a series when not specified by user.
+_heightChangeHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the heightChange event.
+_leftOrigin
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Th x-coordinate for the left edge of the series.
+_styles
+ Object
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Storage for styles attribute.
_stylesChangeHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the stylesChange event.
+_visibleChangeHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the visibleChange event.
+_widthChangeHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the widthChange event.
+_xAxisChangeHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the xAxisChange event.
+_xDataReadyHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the x-axis' dataReady event.
+_xDataUpdateHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the x-axis dataUpdate event.
+_xDisplayName
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Storage for xDisplayName attribute.
_yAxisChangeHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the yAxisChange event.
+_yDataReadyHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the y-axis dataReady event.
+_yDataUpdateHandle
+ EventHandle
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Event handle for the y-axis dataUpdate event.
+_yDisplayName
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Storage for yDisplayName attribute.
GUID
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Constant used to generate unique id.
+name
+ String
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+ The string used to identify the class of this object.
+Attributes
+ + +categoryDisplayName
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Name used for for displaying category data
+Fires event categoryDisplayNameChange
+
+
+ Fires when the value for the configuration attribute categoryDisplayName 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.+
+
+ -
+
chart
+ ChartBase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the Chart application. If no Chart application is present,
+a reference to the Graphic instance that the series is drawn into will be returned.
Fires event chartChange
+
+
+ Fires when the value for the configuration attribute chart 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
+
+
+
+
+ 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.+
+
+ -
+
direction
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Direction of the series
+Fires event directionChange
+
+
+ Fires when the value for the configuration attribute direction 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.+
+
+ -
+
downcandle
+ Path
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the candlestick used when the open value is higher than the close value.
+Fires event downcandleChange
+
+
+ Fires when the value for the configuration attribute downcandle 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.+
+
+ -
+
graph
+ Graph
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the Graph in which the series is drawn into.
Fires event graphChange
+
+
+ Fires when the value for the configuration attribute graph 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The graphic in which drawings will be rendered.
+Fires event graphicChange
+
+
+ Fires when the value for the configuration attribute graphic is
+ changed. You can listen for the event using the on method if you
+ wish to be notified before the attribute's value has changed, or
+ using the after method if you wish to be notified after the
+ attribute's value has changed.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
graphOrder
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Order of the instance
+Fires event graphOrderChange
+
+
+ Fires when the value for the configuration attribute graphOrder 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.+
+
+ -
+
groupMarkers
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.
+Fires event groupMarkersChange
+
+
+ Fires when the value for the configuration attribute groupMarkers 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the height of the parent graph
+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.+
+
+ -
+
initialized
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ 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.+
+
+ -
+
ohlc
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Values to be used for open, high, low and close keys.
+Fires event ohlcChange
+
+
+ Fires when the value for the configuration attribute ohlc 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.+
+
+ -
+
order
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Order of this instance of this type.
Fires event orderChange
+
+
+ Fires when the value for the configuration attribute order 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether the Series has been through its initial set up.
+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.+
+
+ -
+
seriesTypeCollection
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of all series of the same type used within a chart application.
+Fires event seriesTypeCollectionChange
+
+
+ Fires when the value for the configuration attribute seriesTypeCollection 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Style properties used for drawing candles and wicks. This attribute is inherited from RangeSeries. Below are the default values:
+
-
+
- upcandle
- Properties for a candle representing a period that closes higher than it opens.
+
-
+
- fill
- A hash containing the following values:
+
-
+
- color
- Color of the fill. The default value is "#00aa00". +
+ - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1. +
+ - border
- A hash containing the following values:
+
-
+
- color
- Color of the border. The default value is "#000000". +
- alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1. +
- weight
- Number indicating the width of the border. The default value is 0. +
+
-
+
- fill
- A hash containing the following values:
+
-
+
- color
- Color of the fill. The default value is "#aa0000". +
+ - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1. +
-
+
- color
- Color of the border. The default value is "#000000". +
- alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1. +
- weight
- Number indicating the width of the border. The default value is 0. +
-
+
- color
- The color of the wick. The default value is "#000000". +
- weight
- The weight of the wick. The default value is 1. +
- alpha
- Number from 0 to 1 indicating the opacity of the wick. The default value is 1. +
Fires event stylesChange
+
+
+ Fires when the value for the configuration attribute styles is
+ changed. You can listen for the event using the on method if you
+ wish to be notified before the attribute's value has changed, or
+ using the after method if you wish to be notified after the
+ attribute's value has changed.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
type
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Read-only attribute indicating the type of series.
+Default: candlestick
+ + + +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.+
+
+ -
+
upcandle
+ Path
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the candlestick used when the close value is higher than the open value.
+Fires event upcandleChange
+
+
+ Fires when the value for the configuration attribute upcandle 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.+
+
+ -
+
valueDisplayName
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Name used for for displaying value data
+Fires event valueDisplayNameChange
+
+
+ Fires when the value for the configuration attribute valueDisplayName 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether to show the series
+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.+
+
+ -
+
wick
+ Path
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the line drawn between the high and low values.
+Fires event wickChange
+
+
+ Fires when the value for the configuration attribute wick 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.+
+
+ -
+
xAxis
+ Axis
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the Axis instance used for assigning
+x-values to the graph.
Fires event xAxisChange
+
+
+ Fires when the value for the configuration attribute xAxis 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.+
+
+ -
+
xcoords
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ x coordinates for the series.
+Fires event xcoordsChange
+
+
+ Fires when the value for the configuration attribute xcoords 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.+
+
+ -
+
xData
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Array of x values for the series.
+Fires event xDataChange
+
+
+ Fires when the value for the configuration attribute xData 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.+
+
+ -
+
xDisplayName
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name used for for displaying data related to the x-coordinate.
+Fires event xDisplayNameChange
+
+
+ Fires when the value for the configuration attribute xDisplayName 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.+
+
+ -
+
xKey
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates which array to from the hash of value arrays in
+the x-axis Axis instance.
Fires event xKeyChange
+
+
+ Fires when the value for the configuration attribute xKey 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.+
+
+ -
+
xMarkerPlane
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Collection of area maps along the xAxis. Used to determine mouseover for multiple +series.
+Fires event xMarkerPlaneChange
+
+
+ Fires when the value for the configuration attribute xMarkerPlane 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.+
+
+ -
+
xMarkerPlaneOffset
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Distance from a data coordinate to the left/right for setting a hotspot.
+Fires event xMarkerPlaneOffsetChange
+
+
+ Fires when the value for the configuration attribute xMarkerPlaneOffset 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.+
+
+ -
+
yAxis
+ Axis
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to the Axis instance used for assigning
+y-values to the graph.
Fires event yAxisChange
+
+
+ Fires when the value for the configuration attribute yAxis 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.+
+
+ -
+
ycoords
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ y coordinates for the series
+Fires event ycoordsChange
+
+
+ Fires when the value for the configuration attribute ycoords 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.+
+
+ -
+
yData
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Array of y values for the series.
+Fires event yDataChange
+
+
+ Fires when the value for the configuration attribute yData 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.+
+
+ -
+
yDisplayName
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name used for for displaying data related to the y-coordinate.
+Fires event yDisplayNameChange
+
+
+ Fires when the value for the configuration attribute yDisplayName 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.+
+
+ -
+
yKey
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates which array to from the hash of value arrays in
+the y-axis Axis instance.
Fires event yKeyChange
+
+
+ Fires when the value for the configuration attribute yKey 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.+
+
+ -
+
yMarkerPlane
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Collection of area maps along the yAxis. Used to determine mouseover for multiple +series.
+Fires event yMarkerPlaneChange
+
+
+ Fires when the value for the configuration attribute yMarkerPlane 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.+
+
+ -
+
yMarkerPlaneOffset
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Distance from a data coordinate to the top/bottom for setting a hotspot.
+Fires event yMarkerPlaneOffsetChange
+
+
+ Fires when the value for the configuration attribute yMarkerPlaneOffset 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
+
+
+
+
+
+
+
+
+
+
+
+
+ +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:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object
+
+
+
init
+
+
+
+
+
+
+
+
+
+
+
+
+ +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.
+
+
+