Show:

A base class for SchedulerEventSupport.

Constructor

A.SchedulerEventSupport

(
  • config
)

Parameters:

  • config Object

    Object literal specifying widget configuration properties.

Methods

_afterAddEvent

(
  • event
)
protected

Handles add events.

Parameters:

_toSchedulerEvents

(
  • values
)
A.SchedulerEvents protected

Converts given values to SchedulerEvents.

Parameters:

Returns:

A.SchedulerEvents:

The values converted to SchedulerEvents.

addEvents

(
  • models
)
A.SchedulerEvents

Adds and returns the collection of events for this Scheduler.

Parameters:

Returns:

eachEvent

(
  • fn
)
A.SchedulerEvents

Applies a function to the collection of Scheduler events.

Parameters:

  • fn Function

Returns:

flushEvents

()

Deletes each event in the collection of Scheduler events.

getEventByClientId

(
  • clientId
)
Object

Returns the event by matching it's clientId.

Parameters:

  • clientId String

Returns:

Object:

getEvents

(
  • filterFn
  • skipSort
)
Array

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

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

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

Construction logic executed during SchedulerEventSupport instantiation. Lifecycle.

Parameters:

  • config Object

removeEvents

(
  • models
)
A.SchedulerEvents

Removes given SchedulerEvents from the scheduler.

Parameters:

Returns:

A.SchedulerEvents:

Removed SchedulerEvents.

resetEvents

(
  • models
)
A.SchedulerEvents

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

Parameters:

Returns:

A.SchedulerEvents:

Reset SchedulerEvents.

Properties

ATTRS

Object static

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

Events

plotViewEvents

Fired when the current image will be animated in.