Scheduler

WIP description for Scheduler

getSelectedPeriod ( )

addItem ( name: String , start: Object , end: Object , section: Object )

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: String )

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.

daysInWeek ( ) →{ Array }

Returns an array of weekdays.

Returns

An array of {val, label} hashes representing the weekdays.

getCurrentPeriod ( ) →{ Object }

Returns the scheduler's currently selected period.

Returns

The current period

getItem ( id: String ) →{ Object }

Returns the item with the specified ID.

Parameters
Name Type Description
id String The id of the item.
Returns

The item with the specified ID.

getItems ( ) →{ Array }

Returns an array of all items.

Returns

An array of all items.

getPeriods ( ) →{ Array }

Returns an array of all of the scheduler's periods.

Returns

An array containing all of the scheduler's periods.

getSections ( ) →{ Array }

Returns an array of all of the scheduler's sections.

Returns

An array holding all of the scheduler's sections.

getStart ( ) →{ Date }

Returns the start date of the scheduler

Returns

The start date

refresh ( )

Refreshes the widget.

setAllocationLabelType ( type: String , preventUpdate: Boolean )

Sets the type of the allocation label.

Parameters
Name Type Description
type String
preventUpdate Boolean

setCellException ( start: Object , end: Object , preventUpdate: Boolean )

Sets the cell exception.

Parameters
Name Type Description
start Object Start time
end Object End time
preventUpdate Boolean

setCustomPeriod ( period: Object , skipEvent: Boolean , keepStart: Boolean )

Creates and sets a custom period.

Parameters
Name Type Description
period Object The period to create.
skipEvent Boolean
keepStart Boolean

setFilter ( filter: Object )

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
NameTypeDescription
filterStringAn section attribute to filter on.
valueObjectThe desired value of the section attribute.

setPeriod ( period: Object , skipEvent: Boolean , keepStart: Boolean )

Sets the scheduler's selected period

Parameters
Name Type Description
period Object The new period.
skipEvent Boolean
keepStart Boolean

setStartAndEnd ( start: Date, end: Date)

Sets the displayed start and end dates.

Parameters
Name Type Description
start Date The start date.
end Date The end date.

setStartDate ( start: Date)

Sets the start date of the scheduler

Parameters
Name Type Description
start Date The new start date.

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) →{ Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) →{ ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) →{ Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) →{ Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) →{ Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.

Widgets