Version 7 was just released!
The docs will be moved here soon.
Visit the external v7 docs site
Docs Resource Data
How to get resources onto your calendar and how to manipulate resource data thereafter.
resources (as an array)
Tells the calendar to display resources from an array input.
resources (as a JSON feed)
Tells the calendar to fetch the resource list from a remote script.
resources (as a function)
A custom function for programmatically generating raw Resources objects.
Resource Parsing
All of the techniques for specifying resources accept an array of raw objects. These raw objects are “parsed” into proper Resource objects, which are accessible via methods like getResources and getResourceById.
Resource Object
Raw resource object are eventually parsed into proper resource objects, which are accessible via Calendar methods such as getResources and getResourceById. You can read their properties or manipulate them via methods.
Associating Events with Resources
How to specify which resources your events are assigned to.
refetchResourcesOnNavigate
Whether to refetch and rerender resources when the user navigates to a different date or changes the view.
initialResources
This is exactly like specifying resources as an array except that if the supplied value changes, the calendar will NOT be updated to reflect. Only applicable to declarative front-end frameworks such as React, Vue, and Angular.
Methods
refetchResources
Causes the resource data to be fetched and freshly rerendered.
getTopLevelResources
A method that retrieves only top-level Resources.
getResources
A method that retrieves all Resources, including children, as a single flat list.
getResourceById
A method that retrieves a specific Resource Object in memory.
addResource
Allows programmatic rendering of a new resource on the calendar after the initial set of resources has already been displayed.
Resource::getParent
Returns the parent Resource of a child resource.
Resource::getChildren
Returns a list of a resource’s child resources.
Resource::getEvents
Retrieves a list of Event Objects that are associated with the given resource.
Resource::setProp
Modifies any of the properties of a Resource Object.
Resource::setExtendedProp
Modifies a single property in an Resource Object’s extendedProps hash.
Resource::remove
Programmatically removes a resource from the calendar.
Resource::toPlainObject
Serializes a Resource API Object to a plain object that would be fit for JSON.stringify.
Callbacks
See Also
Event::getResources
Gets the Resources associated with the given event.
Event::setResources
Sets the Resources associated with the given event.
businessHours-per-resource
The main businessHours settings can be applied more granularly to individual resources via the businessHours property on the Resource input
loading
Triggered when event or resource fetching starts/stops.
