YearView

A date which specifies the year to display. All types of calendar view have a date config which they use to set their visible date range according to their configuration and type.

When overflowPopupTrigger is not a mouseover gesture, setting this to a truthy value means that a tooltip containing the event count will be shown on hover of a day cell.

It may be specified as an Object which contains Tooltip config options, and also the following option:

• showNoEvents - When set to true, a tooltip containing "No events" is shown when hovering empty day cells.

For example:

{
    modes : {
        year : {
            // We want it to show if there are no visible events for that date.
            // And we want the tip showing to the right of the cell
            eventCountTip : {
                showNoEvents : true,
                align        : 'l-r
            }
        }
    }
}

When showEvents is 'dots', this controls the layout of the dots below the day number.

If the max property is 1, the dots will be coloured using the default event colour, not the colour of the event. This is to create a consistent appearance.

How to indicate the presence of events for a date. The default is heatmap which adds classes depending on how many events intersect the date.Values may be:

• false - Do not show events in cells.
• true - Show a heatmap of colours the intensity of which indicates event load.
• 'heatmap' - Show a heatmap of colours the intensity of which indicates event load.
• 'count' - Show a themeable badge containing the event count for a date.
• 'dots' - Show small event-coloured bullets up to a maximum of eventDots.max to indicate event presence. to indicate event presence.

By default, all months show six week rows. Pass false to only render as many rows as needed.

The year to display

An empty function by default, but provided so that you can override it.

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

The cellConfig (a DomConfig) definition passed as part of the single parameter may be mutated to add style and className.

dayCellRenderer : function(cellData) {
    // I don't like Mondays!
    if (cellData.date === 1) {
        cellData.cls['dayoff'] = true;
    }
}

A non-null return value from the renderer is used as the content of the day cell element.

When overflowPopupTrigger is not a mouseover gesture, setting this to a truthy value means that a tooltip containing the event count will be shown on hover of a day cell.

It may be specified as an Object which contains Tooltip config options, and also the following option:

• showNoEvents - When set to true, a tooltip containing "No events" is shown when hovering empty day cells.

For example:

{
    modes : {
        year : {
            // We want it to show if there are no visible events for that date.
            // And we want the tip showing to the right of the cell
            eventCountTip : {
                showNoEvents : true,
                align        : 'l-r
            }
        }
    }
}

When showEvents is 'dots', this controls the layout of the dots below the day number.

If the max property is 1, the dots will be coloured using the default event colour, not the colour of the event. This is to create a consistent appearance.

Returns the resource associated with this year view when used inside a ResourceView

How to indicate the presence of events for a date. The default is heatmap which adds classes depending on how many events intersect the date.Values may be:

• false - Do not show events in cells.
• true - Show a heatmap of colours the intensity of which indicates event load.
• 'heatmap' - Show a heatmap of colours the intensity of which indicates event load.
• 'count' - Show a themeable badge containing the event count for a date.
• 'dots' - Show small event-coloured bullets up to a maximum of eventDots.max to indicate event presence. to indicate event presence.