Documentation

Binding Functions

Explore this comprehensive list of all public API functions available in a Calendar.js binding class instance. Use these methods to integrate, customize, and extend your calendar functionality.

Example

$calendar.getIds();

Manage Instances

$calendar.render( elementId ):

Renders a new map on an element using the options specified.
Parameter: elementId: Object - The element to render.
Returns: Object - The Calendar.js binding class instance.

$calendar.renderAll():

Finds all new map elements and renders them.
Returns: Object - The Calendar.js binding class instance.

$calendar.instance( elementId ):

Returns the Calendar.js instance for a specific element ID.
Parameter: elementId: Object - The element ID used for the Calendar.js instance.
Returns: Object - The Calendar.js class instance.

Configuration

$calendar.setConfiguration( newConfiguration ):

Sets the specific configuration options that should be used.
Fires: onRefresh
Parameter: newConfiguration: Object - All the configuration options that should be set (refer to "Configuration Options" documentation for properties).
Returns: Object - The Calendar.js binding class instance.

Additional Data

$calendar.getIds():

Returns an array of element IDs that have been rendered.
Returns: string[] - The element IDs that have been rendered.