lightbox

Description

Specifies the lightbox object

lightbox: any

Example

scheduler.config.lightbox.sections = [
    { name: "description", height: 50, type: "textarea", map_to: "text", focus: true },
    { name: "location", height: 43, type: "textarea", map_to: "event_location" },
    { name: "time", height: 72, type: "time", map_to: "auto" }
];
...
scheduler.init('scheduler_here', new Date(2027, 2, 1), "week");

Related samples

• Checkbox in the lightbox
• Radio button in the lightbox

Details

The lightbox object has 1 property:

• sections - (array) specifies the lightbox sections

// default definition
scheduler.config.lightbox.sections = [
    { name: "description", height: 200, map_to: "text", type: "textarea", focus: true },
    { name: "time", height: 72, type: "time", map_to: "auto" }
];

Each object in the sections array can have the following properties:

name	(string) the section's name (according to this name, the scheduler will take the section's label from locale.labels collection). For example for the 'time' section, the scheduler will take the label stored as scheduler.locale.labels.section_time.
height	(number) the section's height
map_to	('auto' or string) the name of a data property that will be mapped to the section (see details below)
type	(textarea,time,select,template,multiselect,radio,checkbox,combo) the type of the section's control (editor)
time_format	(string) sets the order of date-time controls in the 'Time Period' section
focus	(boolean) if set to true, the section will take the focus on opening the lightbox
default_value	(any) the default value of the section's control
onchange	(function) specifies the 'onChange' event handler function for the section's control (for the 'select' control only)
options	(array of objects) defines select options of the control (for 'select', 'multiselect, 'radio', 'combo' controls). Each object in the array specifies a single option and takes these properties: key - (string) the option's id. This attribute is compared with the event's data property to assign select options to events label - (string) the option's label
vertical	(boolean) specifies whether radio buttons should be placed vertically(true) or horizontally (false) (for the 'select' control only)
checked_value	(boolean) the value of the checkbox in the checked state. Optional. By default, true (for the 'checkbox' control only)
unchecked_value	(boolean) the value of the checkbox in the unchecked state. Optional. By default, false (for the 'checkbox' control only)

Meaning of map_to: "auto"

The map_to property can take the "auto" value. The "auto" value relates to the following:

• The control won't return any value and will directly change the value of the related event's properties according to the set_value() method (Custom Lightbox Control).
• Generally, the "auto" value is used for complex controls that work with multiple properties of an event

Related Guides

• Fully Custom Lightbox