SchedulerResourceRendering

Configs

6

Other

Convenience config to set both resourceImagePath and resourceImageExtension.

new Scheduler({
  resourceImages : {
    path      : 'images/resources/',
    extension : '.png'
  }
});
ParameterTypeDescription
pathString

Path to load resource images from

extensionString

Resource image extension

Resources

Generic resource image, used when provided imageUrl or image fields or path calculated from resource name are all invalid. If left blank, resource name initials will be shown when no image can be loaded.

A config object used to configure the resource columns in vertical mode. See ResourceHeader for more details on available properties.

new Scheduler({
    resourceColumns : {
        columnWidth    : 100,
        fillWidth      : false, // this is required for columnWidth to work
        headerRenderer : ({ resourceRecord }) => `${resourceRecord.id} - ${resourceRecord.name}`
    }
})

Resource image extension, used when creating image path from resource name.

Path to load resource images from. Used by the resource header in vertical mode and the ResourceInfoColumn in horizontal mode. Set this to display miniature images for each resource using their image or imageUrl fields.

  • image represents image name inside the specified resourceImagePath,
  • imageUrl represents fully qualified image URL.

If set and a resource has no imageUrl or image specified it will try show miniature using the resource's name with resourceImageExtension appended.

NOTE: The path should end with a /:

new Scheduler({
  resourceImagePath : 'images/resources/'
});

Scheduled events

Control how much space to leave between the first event/last event and the resources edge (top/bottom margin within the resource row in horizontal mode, left/right margin within the resource column in vertical mode), in px. Defaults to the value of barMargin.

Can be configured per resource by setting resource.resourceMargin.

It's also possible to set different values for top/left and bottom/right by assigning an object to resourceMargin with start (margin top in horizontal mode, margin left in vertical mode) and end (margin bottom / margin right) properties:

scheduler = new Scheduler({
    resourceMargin : {
        start : 15,
        end   : 1
    }
});

Properties

5

Class hierarchy

isSchedulerResourceRendering: Boolean= truereadonly
Identifies an object as an instance of SchedulerResourceRendering class, or subclass thereof.
isSchedulerResourceRendering: Boolean= truereadonlystatic
Identifies an object as an instance of SchedulerResourceRendering class, or subclass thereof.

Other

Use it to manipulate resource column properties at runtime.

resourceColumnWidth: Numberreadonly

Get resource column width. Only applies to vertical mode. To set it, assign to scheduler.resourceColumns.columnWidth.

Scheduled events

Control how much space to leave between the first event/last event and the resources edge (top/bottom margin within the resource row in horizontal mode, left/right margin within the resource column in vertical mode), in px. Defaults to the value of barMargin.

Can be configured per resource by setting resource.resourceMargin.

It's also possible to set different values for top/left and bottom/right by assigning an object to resourceMargin with start (margin top in horizontal mode, margin left in vertical mode) and end (margin bottom / margin right) properties:

scheduler = new Scheduler({
    resourceMargin : {
        start : 15,
        end   : 1
    }
});