ResourceCalendar

The ResourceCalendar is designed exclusively for allocating resources to appointments. It is one of the most useful widgets for scheduling, time management or event tracking.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Before MoveFunction called before a move occurs.
Before RemoveFunction called before a removal occurs.
DisabledThe widget cannot be used.
End TimeAttribute for an event's end time.
Exclude WeekendsExclude weekends from the calendar.
Group ByTODO.
HiddenHides the widget from the user.
Interval (days)Attribute for an event's daily interval.
Interval (months)Attribute for an event's monthly interval.
Interval (weeks)Attribute for an event's weekly interval.
Interval (years)Attribute for an event's yearly interval.
Interval ExceptionsRelation to use for exceptions in an event's recurring interval.
Length (repeating events)The length (in hours) of repeating events.
MaximizeSet this widget to be maximized (take up all available space).
Model NameModel for the resource calendar's data.
QueryQuery for the resource calendar's data.
Render FunctionFunction for rendering custom HTML for showing an event.
Replace TimeThe start time of the event to replace with the exception.
ResourceRelation to the resource to show.
Resource FunctionFunction for rendering custom HTMl for showing a resource.
Resource QueryQuery for the resource calendar's resources.
Start TimeAttribute for an event's start time.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.
Title AttributeAttribute for an event's title.

Style

Name Desciption
Background-colorChange background color of the widget.
Body border colorThe border color for the main panel.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Event background colorThe background color for the event indicator in the calendar.
Event border colorThe border color for the event indicator in thee calendar.
Event text colorThe text color for the event highlight area.
Font SizeSet the font size in pixels for text.
Sidebar background colorThe sidebar background color for the panel in the resource calendar.
Sidebar border colorThe border color for the side panel.
Sidebar text colorThe text color for the side panel in resource calendar.
Sidebar text sizeThe text font size for side bar panel in resource calendar.
Sidebar text styleChose text case style for the text in side panel.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.
ItemDoubleClick Triggered when an item in a list, table or a calendar is double clicked.
event Object containing the item (event.item) that was clicked.
LeftIconClick Triggered when the left icon is clicked on the element.
event Object containing the item (event.item) that was clicked.
RowDblClick Triggered when a user double clicks on a row
event Object containing the item (event.item) that was clicked

Function

getCalendarEventManager ( )

getActiveCell ( ) →{ Object }

Returns the currently active cell.

Returns

The currently active cell.

getSections ( ) →{ Array }

Returns the sections.

getSelectedDate ( ) →{ Date }

Returns the currently selected date.

Returns

The currently selected date.

gotoDate ( date: Date )

Selects the specified date in the calendar.

Parameters
Name Type Description
date Date The date to select.

nextWeek ( )

Displays the next week.

previousWeek ( )

Displays the previous week

refresh ( includeSections: Boolean )

Refreshes the calendar

Parameters
Name Type Description
includeSections Boolean If true, also refreshes the sections.

today ( )

Displays today.

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.

Other Widgets