AgendaColumn
A column that displays events for a day.
This is not intended to be used directly, it is used by the AgendaView which is a specialized Grid subclass.
Configs
80
Configs
80Common
Integration
Interaction
Menu
Misc
Rendering
Properties
150
Properties
150Common
Class hierarchy
Editing
Integration
Interaction
JSON
Menu
Misc
Other
Parent & children
Rendering
Functions
77
Functions
77Other
Renderer that shows a list of events for a single date.
Note that all AgendaView columns are automatically set to autoHeight because an unpredictable number of events may appear in any cell.
| Parameter | Type | Description |
|---|---|---|
renderData | Object | Object containing renderer parameters |
renderData.cellElement | HTMLElement | Cell element, for adding CSS classes, styling etc. Can be |
renderData.value | * | Value to be displayed in the cell |
renderData.record | AgendaCell | A AgendaCell context object
which contains contextual information about the date being rendered and an |
renderData.column | Column | This column |
renderData.grid | Grid | This grid |
renderData.row | Row | Row object. Can be null in case of export. Use the row's API to manipulate CSS class names. |
renderData.isExport | Boolean |
|
renderData.isMeasuring | Boolean | True if the column is being measured for a |
Configuration
Editing
Events
Identification
Misc
Parent & children
Events
5
Events
5Event handlers
5
Event handlers
5Typedefs
3
Typedefs
3An extension of Model which also includes the properties of a DayCell since AgendaColumn cells are backed by a data model.
| Parameter | Type | Description |
|---|---|---|
view | CalendarView | The owning view of the cell. |
date | Date | The date of the cell. |
key | String | a |
cellIndex | Number | The overall cell index in the cell-based UI being created. |
day | Number | The day of week for the cell: 0=Sunday, 6=Saturday |
columnIndex | Number | The column index in the cell-based UI being created. |
visibleColumnIndex | Number | The visible column index (eg 0 for a Monday if Sunday is the week start day, but was hidden) |
isNonWorking | Boolean |
|
week | Number[] | The |
isOtherMonth | Boolean | The cell is outside the view's primary time range. Only significant when used by a CalendarPanel which encapsulates a single month. |
visible | Boolean |
|
tomorrow | Date | The date of the following cell. |
isRowStart | Boolean |
|
isRowEnd | Boolean |
|
hasOverflow | Boolean |
|
events | EventModel[] | The events which are to be shown for this date. |
resource | ResourceModel | Note this only exists when the cell is owned by a subview of a ResourceView, or while creating resource columns in a DayResourceView. |
renderedEvents | EventBar[] | If this view renders event bars (MonthView,
CalendarRow), then this is an array of
event bar definitions which belong in the cell. Whether all can be rendered depends
upon the view's configured eventHeight and whether
the cell is of fixed height. The |
resourceDayEvents | EventModel[] | The events for the passed resource for the day (applies in a |
timeRanges | TimeRangeModel[] | All time ranges which intersect with this date cell, including short ones which are rendered. |
allDayTimeRanges | TimeRangeModel[] | The all day time ranges which intersect with the whole day of this date cell. |