Provides convenient events and methods related to scrolling. This could be used, for example, to implement infinite scrolling, or to lazy-load content based on the current scroll position.
var body = Y.one('body');
body.plug(Y.Plugin.ScrollInfo);
body.scrollInfo.on('scrollToBottom', function (e) {
// Load more content when the user scrolls to the bottom of the page.
});_addAttrscfgs
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).
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.
_addLazyAttrname
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrdername
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});_afterHostScrolle
Handles DOM scroll events on the host node.
_afterResizeHandles browser resize events.
_afterScrollDelayChangee
Caches the scrollDelay value after that attribute changes to allow
quicker lookups in critical path code.
_afterScrollMarginChangee
Caches the scrollMargin value after that attribute changes to allow
quicker lookups in critical path code.
_afterWindowScrolle
Handles DOM scroll events on the window.
_aggregateAttrsallAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_bindBinds event handlers.
_cloneDefaultValuecfg
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.
cfg
Object
_defAttrChangeFne
eventFastPath
Default function for attribute change events.
e
EventFacade
The event object for attribute change events.
eventFastPath
Boolean
Whether or not we're using this as a fast path in the case of no listeners or not
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_filterAdHocAttrsallAttrs
userVals
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.
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
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.
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfgname
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.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
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.
_getAttrInitValattr
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.
The initial value of the attribute.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
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.
_getFullTypetype
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.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getInstanceAttrCfgsallCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getScrollNodeReturns the DOM node that should be used to lookup scroll coordinates. In
some browsers, the <body> element doesn't return scroll coordinates, and
the documentElement must be used instead; this method takes care of
determining which node should be used.
DOM node.
_getStateValname
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
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).
_initAttributeInitializes AttributeCore
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
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).
_initBaseconfig
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initHierarchyuserVals
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.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA 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.
_isElementOnscreenel
[margin]
Underlying element-based implementation for isNodeOnscreen().
el
HTMLElement
HTML element.
[margin]
Number
optional
Additional margin in pixels beyond the actual
onscreen region that should be considered "onscreen" for the purposes of
this query. Defaults to the value of the scrollMargin attribute.
true if el is at least partially onscreen within the
host node, false otherwise.
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_monitorwhat
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 -> click_attach, click_detach, 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.
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
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
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.
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preInitEventCfgconfig
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.
config
Object
The user configuration object
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publishfullType
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.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_refreshHostBoundingRectCaches the bounding rect of the host node.
If the host node is the body, the bounding rect will be faked to represent the dimensions of the viewport, since the actual body dimensions may extend beyond the viewport and we only care about the visible region.
_setname
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAttrname
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrsattrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrValattrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
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.
true if the new attribute value was stored, false if not.
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_triggerScrolle
Mixes detailed scroll information into the given DOM scroll event facade
and fires appropriate local events.
e
EventFacade
Event facade from the DOM scroll event.
addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
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.
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)
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.
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.
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.
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.
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).
A reference to the host object.
addAttrscfgs
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.
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.
A reference to the host object.
addTargeto
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.
o
EventTarget
the target to add
aftertype
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.
A subscription handle capable of detaching the subscription
afterHostEventtype
fn
context
Listens for the "after" moment of events fired by the host object.
Listeners attached through this method will be detached when the plugin is unplugged.
handle The detach handle for the listener.
afterHostMethodmethod
fn
context
Injects a function to be executed after a given method on host object.
The function will be detached when the plugin is unplugged.
handle The detach handle for the injected function.
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
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.
beforeExecutes 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
detach handle
beforeHostMethodmethod
fn
context
Injects a function to be executed before a given method on host object.
The function will be detached when the plugin is unplugged.
handle The detach handle for the injected function.
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
destroyDestroy lifecycle method. Invokes destructors for the class hierarchy.
A reference to this object
destructorDestructor lifecycle implementation.
Removes any event listeners or injected methods applied by the Plugin
detachtype
fn
context
Detach one or more listeners the from the specified event
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)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
doAfterstrMethod
fn
context
Listens for the "after" moment of events fired by the host, or injects code "after" a given method on the host.
strMethod
String
The event to listen for, or method to inject logic after.
fn
Function
The handler function. For events, the "after" moment listener. For methods, the function to execute after the given method is executed.
context
Object
An optional context to call the handler with. The default context is the plugin instance.
handle The detach handle for the listener.
doBeforestrMethod
fn
context
Listens for the "on" moment of events fired by the host, or injects code "before" a given method on the host.
strMethod
String
The event to listen for, or method to inject logic before.
fn
Function
The handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed.
context
Object
An optional context to call the handler with. The default context is the plugin instance.
handle The detach handle for the handler.
firetype
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.
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.
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.
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.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
getname
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.
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"))
The value of the attribute
getAttrsattrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getOffscreenNodes[selector]
[margin]
Returns a NodeList containing all offscreen nodes inside the host node that match the given CSS selector. An offscreen node is any node that is entirely outside the visible (onscreen) region of the host node based on the current scroll location.
Offscreen nodes matching selector.
getOnscreenNodes[selector]
[margin]
Returns a NodeList containing all onscreen nodes inside the host node that match the given CSS selector. An onscreen node is any node that is fully or partially within the visible (onscreen) region of the host node based on the current scroll location.
Onscreen nodes matching selector.
getScrollInfoReturns an object hash containing information about the current scroll
position of the host node. This is the same information that's mixed into
the event facade of the scroll event and other scroll-related events.
Object hash containing information about the current scroll
position. See the scroll event for details on what properties this
object contains.
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
initcfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
initializerconfig
Initializer lifecycle implementation.
config
Object
Configuration object with property name/value pairs.
isNodeOnscreennode
[margin]
Returns true if node is at least partially onscreen within the host
node, false otherwise.
node
HTMLElement | Node | String
Node or selector to check.
[margin]
Number
optional
Additional margin in pixels beyond the actual
onscreen region that should be considered "onscreen" for the purposes of
this query. Defaults to the value of the scrollMargin attribute.
true if node is at least partially onscreen within the
host node, false otherwise.
modifyAttrname
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:
Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
ontype
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.
A subscription handle capable of detaching that subscription
oncetype
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.
A subscription handle capable of detaching the subscription
onceAftertype
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.
A subscription handle capable of detaching that subscription
onceAfterHostEventtype
fn
context
Listens for the "after" moment of events fired by the host object one time only. The listener is immediately detached when it is executed.
Listeners attached through this method will be detached when the plugin is unplugged.
handle The detach handle for the listener.
onceHostEventtype
fn
context
Listens for the "on" moment of events fired by the host object one time only. The listener is immediately detached when it is executed.
Listeners attached through this method will be detached when the plugin is unplugged.
handle The detach handle for the listener.
onHostEventtype
fn
context
Listens for the "on" moment of events fired by the host object.
Listeners attached through this method will be detached when the plugin is unplugged.
handle The detach handle for the listener.
parseTypetype
[pre]
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.
an array containing:
publishtype
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.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
the custom event
refreshDimensionsRefreshes cached position, height, and width dimensions for the host node. If the host node is the body, then the viewport height and width will be used.
This info is cached to improve performance during scroll events, since it's
expensive to touch the DOM for these values. Dimensions are automatically
refreshed whenever the browser is resized, but if you change the dimensions
or position of the host node in JS, you may need to call
refreshDimensions() manually to cache the new dimensions.
removeAttrname
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
resetname
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
name
String
Optional. The name of the attribute to reset. If omitted, all attributes are reset.
A reference to the host object.
setname
value
[opts]
Sets the value of an attribute.
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.
A reference to the host object.
setAttrsattrs
[opts]
Sets multiple attribute values.
A reference to the host object.
subscribesubscribe to an event
toStringDefault toString implementation. Provides the constructor NAME and the instance guid, if set.
String representation for this object
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrsThis 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._NON_ATTRS_CFG
Default: undefined (false)
_handlesThe list of event handles for event listeners or AOP injected methods applied by the plugin to the host object.
_heightHeight of the visible region of the host node in pixels. If the host node is
the body, this will be the same as _winHeight.
_widthWidth of the visible region of the host node in pixels. If the host node is
the body, this will be the same as _winWidth.
destroyedFlag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
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.
e
EventFacade
hostThe plugin's host object.
hostChange
Fires when the value for the configuration attribute host 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.
e
EventFacade
initializedFlag indicating whether or not this object has been through the init lifecycle phase.
Default: false
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.
e
EventFacade
scrollDelayNumber of milliseconds to wait after a native scroll event before
firing local scroll events. If another native scroll event occurs during
this time, previous events will be ignored. This ensures that we don't
fire thousands of events when the user is scrolling quickly.
Default: 50
scrollDelayChange
Fires when the value for the configuration attribute scrollDelay 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.
e
EventFacade
scrollMarginAdditional margin in pixels beyond the onscreen region of the host node that should be considered "onscreen".
For example, if set to 50, then a scrollToBottom event would be fired
when the user scrolls to within 50 pixels of the bottom of the
scrollable region, even if they don't actually scroll completely to the
very bottom pixel.
This margin also applies to the getOffscreenNodes() and
getOnscreenNodes() methods by default.
Default: 50
scrollMarginChange
Fires when the value for the configuration attribute scrollMargin 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.
e
EventFacade
destroyLifecycle 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).
e
EventFacade
Event object
initLifecycle 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).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
scrollFired when the user scrolls within the host node.
This event (like all scroll events exposed by ScrollInfo) is throttled and fired
only after the number of milliseconds specified by the scrollDelay attribute
have passed in order to prevent thrashing.
This event passes along the event facade for the standard DOM scroll event and
mixes in the following additional properties.
atBottom
Boolean
Whether the current scroll position is at the bottom of the scrollable region.
atLeft
Boolean
Whether the current scroll position is at the extreme left of the scrollable region.
atRight
Boolean
Whether the current scroll position is at the extreme right of the scrollable region.
atTop
Boolean
Whether the current scroll position is at the top of the scrollable region.
isScrollDown
Boolean
true if the user scrolled down.
isScrollLeft
Boolean
true if the user scrolled left.
isScrollRight
Boolean
true if the user scrolled right.
isScrollUp
Boolean
true if the user scrolled up.
scrollBottom
Number
Y value of the bottom-most onscreen pixel of the scrollable region.
scrollHeight
Number
Total height in pixels of the scrollable region, including offscreen pixels.
scrollLeft
Number
X value of the left-most onscreen pixel of the scrollable region.
scrollRight
Number
X value of the right-most onscreen pixel of the scrollable region.
scrollTop
Number
Y value of the top-most onscreen pixel of the scrollable region.
scrollWidth
Number
Total width in pixels of the scrollable region, including offscreen pixels.
scrollDownFired when the user scrolls down within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollLeftFired when the user scrolls left within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollRightFired when the user scrolls right within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollToBottomFired when the user scrolls to the bottom of the scrollable region within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollToLeftFired when the user scrolls to the extreme left of the scrollable region within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollToRightFired when the user scrolls to the extreme right of the scrollable region within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollToTopFired when the user scrolls to the top of the scrollable region within the host node.
This event provides the same event facade as the scroll event. See that
event for details.
scrollUpFired when the user scrolls up within the host node.
This event provides the same event facade as the scroll event. See that
event for details.