TimeVisualizingEditor
A specialized EventEditor which contains a time visualizer DayView showing the event being edited in context of the time span of the day.
To use this as the event editor in your application, configure your Calendar EventEdit feature's editorConfig as follows:
features : {
eventEdit : {
// Our event editor shows a time visualizer day/week view.
// Make the hour height a little smaller to better fit the editor size.
editorConfig : {
type : 'timevisualizingeditor',
maximizable : true,
timeVisualizer : {
hourHeight : 30
}
}
}
}
When maximized, if the editor width is at least 900px, the time visualizer will show a week view instead of a day view to give more context.
The user can also toggle between day and week view using the buttons in the editor tbar when maximized and width >= 900px.
The responsive configuration of the editor is
responsive : {
small : {
when : 900
}
}
This means that when the editor width is less than 900px, the time visualizer will always show a day view, even when maximized. This may be reconfigured by changing or removing the responsive configuration of the editor.
The time visualizer will only be shown when editing intra-day events. Day-spanning events will not show the time visualizer.
The time visualizer will show the event being edited and, optionally, other events occurring on the same day. This is configured by the showOtherEvents config.
Useful configs
| Config | Description |
|---|---|
| timeVisualizer | Configuration for the embedded DayView time visualizer |
| timeVisualizerCalendar | Configuration for the time visualizer's Calendar wrapper |
| showOtherEvents | Show other events alongside the event being edited |
See also
- EventEdit — The feature that uses this editor
- EventEditor — Parent class providing base editor functionality
- DayView — The day view embedded as the time visualizer
Configs
Configs are options you supply in a configuration object when creating an instance of this class-
Whether to show other events occurring at the same time as the event being edited in the time visualizer. If
true, all day events will be shown as well.- allDay : Booleantrue
Configure as
falseto not show all day events in the time visualizer.
- allDay : Booleantrue
-
The configuration for the time visualizer DayView shown in the editor.
Has a corresponding runtime timeVisualizer property.
-
Configuration for the time visualizer DayView shown in the editor
Has a corresponding runtime timeVisualizerCalendar property.
Properties
Properties are getters/setters or publicly accessible variables on this class-
Identifies an object as an instance of TimeVisualizingEditor class, or subclass thereof.
-
The DayView instance which is used as the time visualizer in the editor.
Has a corresponding timeVisualizer config.
-
The Calendar instance which is used as the calendar in the editor.
Has a corresponding timeVisualizerCalendar config.
-
The event instance used in the time visualizer to represent the event being edited.
-
Identifies an object as an instance of TimeVisualizingEditor class, or subclass thereof.