ResourceView

A function, or the name of a function in the ownership hierarchy which you can specify to customize event DOM content.

This function is called each time an event is rendered to allow developers to mutate the cell metadata, or the CSS classes to be applied to the event element.

It's called with the event record, and a eventData object which allows you to mutate event metadata such as cls, style.

The cls property is an object whose property names will be added to the event element if the property value is truthy.

The style property is an object containing style properties for the event element.

A non-null return value from the renderer is used as the event body content. A nullish return value causes the default renderer to be used which just uses the event name.

If a string is returned, it is used as the HTML content of the event body element.

If an object is returned, it is used as a DomConfig object to create complex content in the event body element.

 eventRenderer({ eventRecord, renderData }) {
     if (eventRecord.name === 'Doctors appointment') {
         renderData.style.fontWeight = 'bold';
         renderData.cls['custom-cls'] = 1;

         return 'Special doctors appointment';
     }
 }

IMPORTANT: When returning content, be sure to consider how that content should be encoded to avoid XSS (Cross-Site Scripting) attacks. This is especially important when including user-controlled data such as the event's name. The function encodeHtml as well as xss can be helpful in these cases.

For example:

 eventRenderer({ eventRecord }) {
     return StringHelper.xss`Event: ${eventRecord.name}`;
 }

Set to true to hide non-working days

When ResourceTimeRangeModels are included in the data, they are only rendered in subviews of ResourceViews and normal TimeRangeModels are not rendered in subviews of ResourceViews.

Set this to true to render normal TimeRangeModels in subviews of this view.

A field name or a function returning a string to be displayed below resource name in the resource view headers.

const calendar = new Calendar({
    modes : {
        // Mode name can be anything if it contains a "type" property.
        weekResources : {
            type  : 'resource',
            // Get meta string to display
            meta : resource => resource.title
        }
    }
});

If the displayed view is a DateRangeOwner, this may be used to set the range of all child views.

The width of a resource calendar panel (view always stretches to fill window)

Display an avatar in the resource view headers, either as an image or using resource initials.

Looks for an image name in the imageUrl and image fields on the resource. Set resourceImagePath on Calendar to specify where to load images from. If no image is found, resource initials are displayed.

By default, the resource views are displayed in the order that the resources appear in the project's resourceStore, so they will appear in a stable position, meaning when a view is filtered out, then filtering it in will replace it in the same position.

If this config is false, re-adding a view will place it at the end.

A config object used to configure the sub views. The default type used is 'weekview'

After instantiation, while in use, changes to the view property, will be propagated to all child views.

This property may be used to adjust properties of every child view of the resource view in one statement.

The space to leave between each subview.

Returns the value of the child view's fixedDuration property.

Set to true to hide non-working days

If the displayed view is a DateRangeOwner, this may be used to set the range of all child views.

The width of a resource calendar panel (view always stretches to fill window)

A config object used to configure the sub views. The default type used is 'weekview'

After instantiation, while in use, changes to the view property, will be propagated to all child views.

This property may be used to adjust properties of every child view of the resource view in one statement.

The space to leave between each subview.

Yields the views which this ResourceView owns.

Executes the passed function for each child view corresponding to each resource in the resourceStore.