Interface: Scheduler

Scheduler

Extends

Methods

addItem(name, start, end, section)

Adds an item to the scheduler.
Parameters:
Name Type Description
name String The name of the item.
start Object Start time of the item.
end Object End time of the item.
section Object The section that the item should belong to.

addSection(name)

Adds a section to the scheduler
Parameters:
Name Type Description
name String The name of the new section.

clearTimeouts()

Clears all timeouts

daysInMonth() → {Array}

Returns an array of month days.
Returns:
- An array of {val, label} hashes representing the month days.
Type
Array

daysInWeek() → {Array}

Returns an array of weekdays.
Returns:
- An array of {val, label} hashes representing the weekdays.
Type
Array

get(name) → {Object}

Gets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
Inherited From:
Returns:
- The property's value.
Type
Object

getCurrentPeriod() → {Object}

Returns the scheduler's currently selected period.
Returns:
- The current period
Type
Object

getId() → {ID}

Returns the ID of the widget.
Inherited From:
Returns:
- The ID of the widget
Type
ID

getItem() → {Object}

Returns the item with the specified ID.
Parameters:
Type Description
String The id of the item.
Returns:
- The item with the specified ID.
Type
Object

getItems() → {Array}

Returns an array of all items.
Returns:
- An array of all items.
Type
Array

getPeriods() → {Array}

Returns an array of all of the scheduler's periods.
Returns:
- An array containing all of the scheduler's periods.
Type
Array

getSections() → {Array}

Returns an array of all of the scheduler's sections.
Returns:
- An array holding all of the scheduler's sections.
Type
Array

getStart() → {Date}

Returns the start date of the scheduler
Returns:
- The start date
Type
Date

getValue() → {Object}

Returns the widget's value.
Inherited From:
Returns:
- The widget's value.
Type
Object

hide()

Hides the widget.
Inherited From:

isEnabled() → {Boolean}

Returns true if the widget is enabled.
Inherited From:
Returns:
- True if enabled, otherwise false.
Type
Boolean

refresh()

Refreshes the widget.

set(name, value)

Sets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
value Object The new value.
Inherited From:

setAllocationLabelType(type, preventUpdate)

Sets the type of the allocation label.
Parameters:
Name Type Description
type String -
preventUpdate Boolean -

setCellException(start, end, preventUpdate)

Sets the cell exception.
Parameters:
Name Type Description
start Object Start time
end Object End time
preventUpdate Boolean -

setCustomPeriod(period, skipEvent, keepStart)

Creates and sets a custom period.
Parameters:
Name Type Description
period Object The period to create.
skipEvent Boolean -
keepStart Boolean -

setEnabled(Enabled)

Enables/disables the widget.
Parameters:
Name Type Description
Enabled Boolean True to enable the widget, false to disable.
Inherited From:

setFilter(filter)

Sets a filter. The filter is used to filter displayed sections.
Parameters:
Name Type Description
filter Object An object containing the fields to use for the filter.
Properties
Name Type Description
filter String An section attribute to filter on.
value Object The desired value of the section attribute.

setLabel(Label)

Sets the label on the button.
Parameters:
Name Type Description
Label String Text or HTML to set as the label on this button.
Overrides:

setPeriod(period, skipEvent, keepStart)

Sets the scheduler's selected period
Parameters:
Name Type Description
period Object The new period.
skipEvent Boolean -
keepStart Boolean -

setStartAndEnd(start, end)

Sets the displayed start and end dates.
Parameters:
Name Type Description
start Date The start date.
end Date The end date.

setStartDate(start)

Sets the start date of the scheduler
Parameters:
Name Type Description
start Date The new start date.

setStyle(Object)

Set the widget-style
Parameters:
Name Type Description
Object Object with style-properties
Inherited From:

setValue()

Sets the widget's value.
Parameters:
Type Description
Object The new value.
Overrides:

show()

Shows the widget.
Overrides: