AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.SchedulerEventSupport Class

    Defined in: alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:219
    Module: aui-scheduler-base
    Parent Module: aui-scheduler

    A base class for SchedulerEventSupport.

    Constructor

    A.SchedulerEventSupport

    (
    • config
    )

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:219

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterAddEvent

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:428

    Handles add events.

    Parameters:

    _toSchedulerEvents

    (
    • values
    )
    A.SchedulerEvents protected

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:441

    Converts given values to SchedulerEvents.

    Parameters:

    Returns:

    A.SchedulerEvents:

    The values converted to SchedulerEvents.

    addEvents

    (
    • models
    )
    A.SchedulerEvents

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:272

    Adds and returns the collection of events for this Scheduler.

    Parameters:

    Returns:

    A.SchedulerEvents:

    eachEvent

    (
    • fn
    )
    A.SchedulerEvents

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:286

    Applies a function to the collection of Scheduler events.

    Parameters:

    • fn Function

    Returns:

    A.SchedulerEvents:

    flushEvents

    ()

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:299

    Deletes each event in the collection of Scheduler events.

    getEventByClientId

    (
    • clientId
    )
    Object

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:312

    Returns the event by matching it's clientId.

    Parameters:

    • clientId String

    Returns:

    Object:

    getEvents

    (
    • filterFn
    • skipSort
    )
    Array

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:325

    Gets a collection of events.

    Parameters:

    • filterFn Function

      (optional) Filters events and returns a list of events.

    • skipSort Boolean

    Returns:

    Array:

    getEventsByDay

    (
    • date
    • includeOverlap
    )
    Array

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:355

    Gets a collection of events within a given day. It will filter overlapping events by default unless includeOverlap is true.

    Parameters:

    • date Date
    • includeOverlap Boolean

    Returns:

    Array:

    getIntersectEvents

    (
    • date
    )
    Array

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:375

    Returns the list of all events that intersect with a given date. Events that are not visible are not included in this list.

    Parameters:

    Returns:

    Array:

    initializer

    (
    • config
    )
    protected

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:246

    Construction logic executed during SchedulerEventSupport instantiation. Lifecycle.

    Parameters:

    • config Object

    removeEvents

    (
    • models
    )
    A.SchedulerEvents

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:399

    Removes given SchedulerEvents from the scheduler.

    Parameters:

    Returns:

    A.SchedulerEvents:

    Removed SchedulerEvents.

    resetEvents

    (
    • models
    )
    A.SchedulerEvents

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:413

    Completely replaces all SchedulerEvents in the list with the given SchedulerEvents.

    Parameters:

    Returns:

    A.SchedulerEvents:

    Reset SchedulerEvents.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:229

    Static property used to define the default attribute configuration for the SchedulerEventSupport.

    Events

    plotViewEvents

    Defined in alloy-ui/src/aui-scheduler/js/aui-scheduler-base.js:479

    Fired when the current image will be animated in.