@bryntum/calendar-vue-3 7.1.1

package/src/components/BryntumYearViewProps.ts

@@ -0,0 +1,1061 @@
+import type { AlignSpec, Base, BryntumScrollOptions, ButtonConfig, CalendarView, ContainerItemConfig, ContainerLayoutConfig, DayCell, DomConfig, EventBar, EventModel, KeyMapConfig, MaskConfig, MenuItemConfig, MenuItemEntry, OverflowPopupConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Rectangle, ResourceModel, Scroller, ScrollerConfig, StateProvider, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget, YearCell, YearViewListeners } from '@bryntum/calendar';
+import {  } from '@bryntum/calendar';
+
+export declare type BryntumYearViewProps = {
+    // Configs
+    /**
+     * A key to use to activate this view.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-activationKey)
+     */
+    activationKey ? : string
+    /**
+     * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
+     * content will be placed inside this element.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-adopt)
+     */
+    adopt ? : HTMLElement|string
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-align)
+     */
+    align ? : AlignSpec|string
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container), it will by default be participating in a
+     * flexbox layout. This config allows you to set this widget's
+     * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
+     */
+    alignSelf ? : string
+    /**
+     * Configure this as `false` to disable drag-creating events in this view.
+     */
+    allowDragCreate ? : Boolean
+    /**
+     * Configure this as `false` to disable drag-moving events in this view.
+     */
+    allowDragMove ? : Boolean
+    /**
+     * Configure this as `false` to disable drag-resizing events in this view.
+     */
+    allowDragResize ? : Boolean
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating) and being shown through [showBy](#Core/widget/Widget#function-showBy).*
+     * `true` to show a connector arrow pointing to the align target.
+     */
+    anchor ? : Boolean
+    /**
+     * By default, when navigating through time, the next time
+     * block will be animated in from the appropriate direction.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-animateTimeShift)
+     */
+    animateTimeShift ? : Boolean
+    /**
+     * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
+     * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     */
+    appendTo ? : HTMLElement|string
+    /**
+     * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
+     * into an element which will be linked using the `aria-describedby` attribute.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-ariaDescription)
+     */
+    ariaDescription ? : string
+    /**
+     * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
+     * the `aria-label` attribute.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-ariaLabel)
+     */
+    ariaLabel ? : string
+    /**
+     * If this config is set, then the `gesture` configured (which defaults to `dblclick`) creates a
+     * new event at the mouse or touch event's time point.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-autoCreate)
+     */
+    autoCreate ? : {
+        gesture?: string
+        newName?: Function|string
+        step?: string
+        snapType?: 'round'|'ceil'|'floor'
+        duration?: string
+        startHour?: number
+    }|string|Boolean
+    /**
+     * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
+     * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-bbar)
+     */
+    bbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
+    /**
+     * Custom CSS classes to add to the panel's body element.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-bodyCls)
+     */
+    bodyCls ? : string|object
+    /**
+     * An object where property names with a truthy value indicate which events should bubble up the ownership
+     * hierarchy when triggered.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-bubbleEvents)
+     */
+    bubbleEvents ? : object
+    /**
+     * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-callOnFunctions)
+     */
+    callOnFunctions ? : Boolean
+    /**
+     * By default, if an event handler throws an exception, the error propagates up the stack and the
+     * application state is undefined. Code which follows the event handler will *not* be executed.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-catchEventHandlerExceptions)
+     */
+    catchEventHandlerExceptions ? : Boolean
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * Set to `true` to centre the Widget in browser viewport space.
+     */
+    centered ? : Boolean
+    /**
+     * Custom CSS classes to add to element.
+     * May be specified as a space separated string, or as an object in which property names
+     * with truthy values are used as the class names:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-cls)
+     */
+    cls ? : string|object
+    /**
+     * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
+     * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible).
+     */
+    collapsed ? : Boolean
+    /**
+     * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsed).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-collapsible)
+     */
+    collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
+    /**
+     * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
+     * `style` block.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-color)
+     */
+    color ? : string
+    /**
+     * Programmatic control over which column to start in when used in a grid layout.
+     */
+    column ? : number
+    config ? : object
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating) or [positioned](#Core/widget/Widget#config-positioned).*
+     * Element, Widget or Rectangle to which this Widget is constrained.
+     */
+    constrainTo ? : HTMLElement|Widget|Rectangle
+    /**
+     * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
+     * May be specified as a space separated string, or as an object in which property names
+     * with truthy values are used as the class names:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-contentElementCls)
+     */
+    contentElementCls ? : string|object
+    /**
+     * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
+     * field on the expanded record to use for populating this widget's store (if applicable)
+     */
+    dataField ? : string
+    /**
+     * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
+     */
+    dataset ? : Record<string, string>
+    /**
+     * 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.
+     */
+    date ? : Date
+    /**
+     * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to use to create date output for view descriptions.
+     * @param {Date} date The date to format.
+     * @returns {string} The formatted date.
+     */
+    dateFormat ? : string|((date: Date) => string)
+    /**
+     * A string used to separate start and end dates in the [descriptionFormat](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
+     */
+    dateSeparator ? : string
+    /**
+     * The [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to format the day names
+     * in the header part of each calendar cell.
+     * @param {Date} date The date to format.
+     * @returns {string} The formatted date.
+     */
+    dayCellNameFormat ? : string|((date: Date) => string)
+    /**
+     * An empty function by default, but provided so that you can override it.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-dayCellRenderer)
+     * @param {YearCell} cellData A `DayCell` object that contains data about the cell.
+     * @returns {DomConfig,string,void}
+     */
+    dayCellRenderer ? : (cellData: YearCell) => DomConfig|string|void
+    /**
+     * The name of the property to set when a single value is to be applied to this Widget. Such as when used
+     * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
+     */
+    defaultBindProperty ? : string
+    /**
+     * A [query](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
+     * focus should be directed by default.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-defaultFocus)
+     * @param {Core.widget.Widget} widget Widget passed to method
+     * @returns {boolean} truthy value if widget is the default one
+     */
+    defaultFocus ? : ((widget: Widget) => Boolean)|string
+    /**
+     * A config object containing default settings to apply to all child widgets.
+     */
+    defaults ? : ContainerItemConfig
+    /**
+     * Options to add into scroll options when the [scrollTo](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#function-scrollTo) method is called.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-defaultScrollOptions)
+     */
+    defaultScrollOptions ? : BryntumScrollOptions
+    /**
+     * The date format used by the default [descriptionRenderer](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-descriptionRenderer) for rendering the view's description.
+     * If this value is `null`, the [dateFormat](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-dateFormat) (and potentially [dateSeparator](#Scheduler/view/mixin/Describable#config-dateSeparator)) will
+     * be used.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-descriptionFormat)
+     * @param {Date} date The date to format.
+     * @returns {string} The formatted date.
+     */
+    descriptionFormat ? : string|string[]|Boolean[]|((date: Date) => string)|Function[]
+    /**
+     * A function that provides the textual description for this view. If provided, this function overrides the
+     * [descriptionFormat](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/Describable#config-descriptionFormat).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-descriptionRenderer)
+     * @param {Core.widget.Widget} view The active view in case the function is in another scope.
+     * @returns {string} Description string
+     */
+    descriptionRenderer ? : (view: Widget) => string
+    /**
+     * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-detectCSSCompatibilityIssues)
+     */
+    detectCSSCompatibilityIssues ? : Boolean
+    /**
+     * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
+     * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-disabled)
+     */
+    disabled ? : Boolean|'inert'
+    /**
+     * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel)
+     * [strips collection](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
+     * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
+     * body. Such widgets are called "edge strips".
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-dock)
+     */
+    dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * property which controls when a drag should start.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-draggable)
+     */
+    draggable ? : Boolean|{
+        handleSelector?: string
+    }
+    /**
+     * The [durationUnit](https://bryntum.com/products/calendar/docs/api/Scheduler/model/EventModel#field-durationUnit) to use when drag-creating events
+     * in this view.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-dragUnit)
+     */
+    dragUnit ? : string
+    /**
+     * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-drawer)
+     * @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to.  * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
+     * @param {string,number} size The size of the drawer in its collapsible axis.
+     * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
+     * @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
+     * @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
+     * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
+     * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
+     * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
+     */
+    drawer ? : Boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: Boolean, autoClose: { mousedown?: Boolean|string, focusout?: Boolean|string, mouseout?: string }, autoCloseDelay?: number}
+    /**
+     * An object specifying attributes to assign to the root element of this widget.
+     * Set `null` value to attribute to remove it.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-elementAttributes)
+     */
+    elementAttributes ? : Record<string, string|null>
+    /**
+     * A [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object which will be used to create the content of a clickable
+     * element which is present when no events are in a cell.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-emptyCellRenderer)
+     * @param {DayCell} dayCellRenderer A `DayCell` object that contains data about the cell.
+     * @returns {DomConfig,void} DomConfig object representing the HTML markup
+     */
+    emptyCellRenderer ? : ((dayCellRenderer: DayCell) => DomConfig|void)|object|string
+    /**
+     * When [overflowPopupTrigger](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-eventCountTip)
+     */
+    eventCountTip ? : Boolean|Record<string, Boolean|string>
+    /**
+     * When [showEvents](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-showEvents) is `'dots'`, this controls the layout of the dots
+     * below the day number.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-eventDots)
+     */
+    eventDots ? : {
+        marginTop?: number
+        max?: number
+        gap?: number
+        size?: number
+        stripe?: Boolean
+    }
+    /**
+     * A function, or the name of a function in the ownership hierarchy to filter which events
+     * are collected into the day cell data blocks.
+     * Return `true` to include the passed event, or a *falsy* value to exclude the event.
+     * @param {Scheduler.model.EventModel} event the passed event
+     * @returns {boolean}
+     */
+    eventFilter ? : ((event: EventModel) => Boolean)|string
+    /**
+     * A function, or the name of a function in the ownership hierarchy which you
+     * can specify to customize event DOM content.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-eventHeaderRenderer)
+     * @param {object} detail An object that contains data about the event being rendered
+     * @param {CalendarView} detail.view The view rendering the event
+     * @param {Scheduler.model.EventModel} detail.eventRecord The event record
+     * @param {Scheduler.model.ResourceModel} detail.resourceRecord The resource record
+     * @param {object} detail.renderData A data object containing properties that will be used to create the event element
+     * @param {object} detail.renderData.style The style property is an object containing style properties for the event element
+     * @param {object} detail.renderData.cls The cls property is an object whose property names will be added to the event element if the property value is truthy
+     * @param {object} detail.renderData.iconStyle The iconStyle property is an object containing style properties for the icon element if an icon element is to be used
+     * @param {object} detail.renderData.iconCls The iconCls property is an object whose property names will be added to the icon element. Initially set from the event record's [iconCls](https://bryntum.com/products/calendar/docs/api/Scheduler/model/EventModel#field-iconCls). Can be mutated by the renderer. If null, or no properties are set, no icon will be rendered
+     * @param {string} detail.renderData.eventColor Color to be applied to the event
+     * @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
+     * @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
+     * @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
+     * @param {boolean} detail.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
+     * @returns {DomConfig,DomConfig[],string,void}
+     */
+    eventHeaderRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, dataset: object, solidBar: Boolean, bodyColor: string }, showBullet: Boolean }) => DomConfig|DomConfig[]|string|void)|string
+    /**
+     * The height of event bars if this view creates event bars.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-eventHeight)
+     */
+    eventHeight ? : number|string
+    /**
+     * A function, or the name of a function in the ownership hierarchy which you
+     * can specify to customize event DOM content.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-eventRenderer)
+     * @param {object} detail An object that contains data about the event being rendered
+     * @param {CalendarView} detail.view The view rendering the event
+     * @param {Scheduler.model.EventModel} detail.eventRecord The event record
+     * @param {Scheduler.model.ResourceModel} detail.resourceRecord The Resource record
+     * @param {object} detail.renderData A data object containing properties that will be used to create the event element
+     * @param {object} detail.renderData.style The style property is an object containing style properties for the event element
+     * @param {object} detail.renderData.cls The cls property is an object whose property names will be added to the event element if the property value is truthy
+     * @param {object} detail.renderData.iconStyle The iconStyle property is an object containing style properties for the icon element if an icon element is to be used
+     * @param {object} detail.renderData.iconCls The iconCls property is an object whose property names will be added to the icon element. Initially set from the event record's [iconCls](https://bryntum.com/products/calendar/docs/api/Scheduler/model/EventModel#field-iconCls). Can be mutated by the renderer. If null, or no properties are set, no icon will be rendered
+     * @param {string} detail.renderData.eventColor Color to be applied to the event. This may be a CSS color name or a CSS color value in any of the supported CSS color formats such as `#RRGGBB`, `rgb(255, 0, 0)`, or `rgba(255, 0, 0, 0.5)`.
+     * @param {string} detail.renderData.eventBackground A CSS background style to be applied to the event. This is not set by default, but can be set by the renderer to provide a background image or gradient for the event bar. This overrides the `eventColor` property if present.
+     * @param {string} detail.renderData.textColor A CSS color to be applied to the event text. This is not set by default, but can be set by the renderer to provide a custom color for the event name text in the event bar. This may be a CSS color name or a CSS color value in any of the supported CSS color formats such as `#RRGGBB`, `rgb(255, 0, 0)`, or `rgba(255, 0, 0, 0.5)`.
+     * @param {object} detail.renderData.eventInnerStyle The eventInnerStyle property is an object containing style properties for the inner part of the event element, the `.b-cal-event` element.
+     * @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
+     * @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
+     * @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
+     * @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
+     * @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
+     */
+    eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
+    /**
+     * A function which compares events which some views use to decide upon rendering order.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-eventSorter)
+     * @param {Scheduler.model.EventModel,EventBar} lhs The left side value to conpare
+     * @param {Scheduler.model.EventModel,EventBar} rhs The right side value to conpare
+     * @returns {number}
+     */
+    eventSorter ? : (lhs: EventModel|EventBar, rhs: EventModel|EventBar) => number
+    /**
+     * How much vertical space in pixels to leave between event bars in a cell.
+     */
+    eventSpacing ? : number
+    /**
+     * By default, the end date of an all day event is displayed in the UI as
+     * the last calendar date on which the event falls. For most end users, this is the
+     * expected value.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-extendAllDayEndDay)
+     */
+    extendAllDayEndDay ? : Boolean
+    extraData ? : any
+    /**
+     * If this is set to `true`, then when determining which assigned resource of a multi assigned event
+     * to use to create the event UI, the first resource which is still selected in the
+     * [resourceFilter](https://bryntum.com/products/calendar/docs/api/Calendar/widget/Sidebar#property-resourceFilter) is used.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-filterEventResources)
+     */
+    filterEventResources ? : Boolean
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container), it will by default be participating in a
+     * flexbox layout. This config allows you to set this widget's
+     * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
+     * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
+     * numeric-only values are interpreted as the `flex-grow` value.
+     */
+    flex ? : number|string
+    /**
+     * Set to `true` to move the widget out of the document flow and position it
+     * absolutely in browser viewport space.
+     */
+    floating ? : Boolean
+    /**
+     * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
+     * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-footer)
+     */
+    footer ? : {
+        dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
+        html?: string
+        cls?: string
+    }|string
+    /**
+     * A Function (or name of a function in the ownership hierarchy) which returns the
+     * [resource record](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel) to use to create the UI for an event.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-getPrimaryResource)
+     * @param {Scheduler.model.EventModel} eventRecord The event from which to extract the primary resource.
+     * @returns {Scheduler.model.ResourceModel} The resource to be used to render the event.
+     */
+    getPrimaryResource ? : ((eventRecord: EventModel) => ResourceModel)|string
+    /**
+     * A config [object](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-header)
+     */
+    header ? : string|Boolean|PanelHeader
+    /**
+     * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
+     * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
+     * cases this config is convenient.
+     */
+    height ? : string|number
+    /**
+     * Configure with true to make widget initially hidden.
+     */
+    hidden ? : Boolean
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-hideAnimation)
+     */
+    hideAnimation ? : Boolean|object
+    /**
+     * Configure as `true` to hide [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-nonWorkingDays)
+     */
+    hideNonWorkingDays ? : Boolean
+    /**
+     * Specify `true` to make this container hide when it has no visible children (Either empty
+     * or all children hidden).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-hideWhenEmpty)
+     */
+    hideWhenEmpty ? : Boolean
+    /**
+     * An icon to show before the [title](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
+     * [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
+     */
+    icon ? : string|DomConfig
+    /**
+     * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
+     */
+    id ? : string
+    /**
+     * Determines if the widgets read-only state should be controlled by its parent.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-ignoreParentReadOnly)
+     */
+    ignoreParentReadOnly ? : Boolean
+    /**
+     * Convenience setting to align input fields of child widgets. By default, the Field input element is
+     * placed immediately following the `label`. If you prefer to have all input fields aligned to the
+     * right, set this config to `'end'`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-inputFieldAlign)
+     */
+    inputFieldAlign ? : 'start'|'end'
+    /**
+     * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     */
+    insertBefore ? : HTMLElement|string
+    /**
+     * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     */
+    insertFirst ? : HTMLElement|string
+    /**
+     * An optional CSS class to add to child items of this container.
+     */
+    itemCls ? : string
+    /**
+     * An object containing typed child widget config objects or Widgets. May also be specified
+     * as an array.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-items)
+     */
+    items ? : Record<string, ContainerItemConfig|MenuItemEntry>|(ContainerItemConfig|MenuItemEntry|Widget)[]
+    /**
+     * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
+     * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
+     * are the name of the instance method to call when the keystroke is received.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-keyMap)
+     */
+    keyMap ? : Record<string, KeyMapConfig>
+    /**
+     * Convenience setting to use same label placement on all child widgets.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-labelPosition)
+     */
+    labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
+    /**
+     * The short name of a helper class which manages rendering and styling of child items.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-layout)
+     */
+    layout ? : string|ContainerLayoutConfig
+    /**
+     * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-layoutStyle)
+     */
+    layoutStyle ? : object
+    /**
+     * An array of [child item](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
+     * instances only when this Container is rendered, rather than eagerly at construct time.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-lazyItems)
+     */
+    lazyItems ? : Record<string, ContainerItemConfig>|ContainerItemConfig[]|Widget[]
+    /**
+     * The listener set for this object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-listeners)
+     */
+    listeners ? : YearViewListeners
+    /**
+     * A class translations of which are used for translating this entity.
+     * This is often used when translations of an item are defined on its container class.
+     * For example:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-localeClass)
+     */
+    localeClass ? : typeof Base
+    /**
+     * Set to `false` to disable localization of this object.
+     */
+    localizable ? : Boolean
+    /**
+     * List of properties which values should be translated automatically upon a locale applying.
+     * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
+     * you could use 'localeKey' meta configuration.
+     * Example:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-localizableProperties)
+     */
+    localizableProperties ? : string[]
+    /**
+     * Widget's margin. This may be configured as a single number or a `TRBL` format string.
+     * numeric-only values are interpreted as pixels.
+     */
+    margin ? : number|string
+    /**
+     * This config object contains the defaults for the [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) created for the
+     * [masked](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
+     * values.
+     */
+    maskDefaults ? : MaskConfig
+    /**
+     * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
+     * [Mask](https://bryntum.com/products/calendar/docs/api/Core/widget/Mask) config object.
+     */
+    masked ? : Boolean|string|MaskConfig
+    /**
+     * The maximum date to which the `endDate` of this view may be navigated.
+     */
+    maxDate ? : Date|string
+    /**
+     * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [height](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
+     */
+    maxHeight ? : string|number
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-maximizeOnMobile)
+     */
+    maximizeOnMobile ? : number|string
+    /**
+     * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
+     */
+    maxWidth ? : string|number
+    /**
+     * The minimum date to which the `startDate` of this view may be navigated.
+     */
+    minDate ? : Date|string
+    /**
+     * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [height](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
+     */
+    minHeight ? : string|number
+    /**
+     * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
+     */
+    minWidth ? : string|number
+    /**
+     * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
+     * is used to monitor this element for size changes caused by either style manipulation, or by CSS
+     * layout.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-monitorResize)
+     */
+    monitorResize ? : Boolean|{
+        immediate?: Boolean
+    }
+    /**
+     * An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items)
+     * config. For example, a specialized [Menu](https://bryntum.com/products/calendar/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
+     * value defined like this:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-namedItems)
+     */
+    namedItems ? : Record<string, ContainerItemConfig>
+    /**
+     * Non-working days as an object where keys are day indices, 0-6 (Sunday-Saturday), and the value is `true`.
+     * Defaults to [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper#property-nonWorkingDays-static).
+     */
+    nonWorkingDays ? : Record<number, Boolean>
+    /**
+     * A function, or name of a function which is passed the [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object which
+     * will be used to create the "+n more" button which indicates that a day cell has
+     * overflowing events.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-overflowButtonRenderer)
+     * @param {DomConfig,object} domConfig A [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) config object which is used to create the overflow button.
+     * @param {string} domConfig.tag The tag name of the element to create.
+     * @param {object} domConfig.className An object who's truthy property names will be applied as class names.
+     * @param {string} domConfig.text The inner content of the element. <strong>Note that this will be HTML encoded for XSS safety</strong>
+     * @param {object} domConfig.style A CSS style definition object.
+     * @param {object} domConfig.dataset The DOM data properties to set.
+     * @param {number} overflowCount The number of overflowing events.
+     * @returns {DomConfig,string,void}
+     */
+    overflowButtonRenderer ? : (domConfig: { tag: string, className: object, text: string, style: object, dataset: object }, overflowCount: number) => DomConfig|string|void
+    /**
+     * A config object used to create the [OverflowPopup](https://bryntum.com/products/calendar/docs/api/Calendar/widget/OverflowPopup) that this view
+     * may show when events for one day overflow the available space.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-overflowPopup)
+     */
+    overflowPopup ? : OverflowPopupConfig
+    /**
+     * The pointer gesture which shows the popup containing any overflowing events
+     * in the current view.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-overflowPopupTrigger)
+     */
+    overflowPopupTrigger ? : 'click'|'mouseover'|'hover'
+    /**
+     * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
+     * [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
+     * the owner is <strong>always</strong> the encapsulating Container.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-owner)
+     */
+    owner ? : Widget|any
+    /**
+     * The class name to add to events which have an end date in the past. Defaults to `'b-past-event'`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-pastEventCls)
+     */
+    pastEventCls ? : string
+    /**
+     * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement), but must
+     * not participate in the standard layout of that widget, and must be positioned relatively to that
+     * widget's [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-positioned)
+     */
+    positioned ? : Boolean
+    /**
+     * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
+     * menu on click etc, since the tooltip would be displayed at the same time.
+     */
+    preventTooltipOnTouch ? : Boolean
+    /**
+     * Whether this widget is read-only.  This is only valid if the widget is an input
+     * field, <strong>or contains input fields at any depth</strong>.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-readOnly)
+     */
+    readOnly ? : Boolean
+    relayStoreEvents ? : Boolean
+    /**
+     * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
+     * `type`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-rendition)
+     */
+    rendition ? : string|Record<string, string>|null
+    /**
+     * Path to load resource images from. Used by the [showResourceAvatars](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showResourceAvatars) config
+     * to create URLs using the resource's
+     * [image](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel#field-image) or
+     * [imageUrl](https://bryntum.com/products/calendar/docs/api/Scheduler/model/ResourceModel#field-imageUrl) fields:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-resourceImagePath)
+     */
+    resourceImagePath ? : string
+    /**
+     * Specifies the various responsive state objects keyed by their name. Each key (except `'*'`, see below) in
+     * this object is a state name (see [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState)) and its corresponding value is the
+     * associated [ResponsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#typedef-ResponsiveState) object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-responsive)
+     */
+    responsive ? : object
+    /**
+     * Set to `true` to mark this instance as the default [responsiveTarget](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) for descendants that do
+     * not specify an explicit [responsiveTarget](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) of their own.
+     */
+    responsiveRoot ? : Boolean
+    /**
+     * The name of the active state of the [responsive](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsive) config. This is assigned internally
+     * and should not be assigned directly.
+     */
+    responsiveState ? : string
+    /**
+     * The widget whose size and other properties drive this object's responsive behavior. If this config is not
+     * specified, the closest ancestor that specified [responsiveRoot=true](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveRoot) will be
+     * used. If there is no such ancestor, then the instance using this mixin is used.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-responsiveTarget)
+     */
+    responsiveTarget ? : string|Widget
+    /**
+     * Configure as `true` to have the component display a translucent ripple when its
+     * [focusElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
+     * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-ripple)
+     */
+    ripple ? : Boolean|{
+        delegate?: string
+        color?: string
+        radius?: number
+        clip?: string
+    }
+    /**
+     * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
+     */
+    rootElement ? : ShadowRoot|HTMLElement
+    /**
+     * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-rtl)
+     */
+    rtl ? : Boolean
+    /**
+     * Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
+     * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
+     * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
+     * CSS overflow properties thus:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-scrollable)
+     */
+    scrollable ? : Boolean|ScrollerConfig|Scroller
+    /**
+     * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
+     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     */
+    scrollAction ? : 'hide'|'realign'|null
+    /**
+     * A button configuration object to use for the automatically created mode selector button for this mode.
+     */
+    selectorButton ? : ButtonConfig
+    /**
+     * A menu item configuration object to use for the automatically created mode selector menu item for this mode.
+     */
+    selectorMenuItem ? : MenuItemConfig
+    /**
+     * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to use to create date output for
+     * abbreviated view descriptions.
+     * @param {Date} date The date to format.
+     * @returns {string} The formatted date.
+     */
+    shortDateFormat ? : string|((date: Date) => string)
+    /**
+     * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function to use to create date and time output for
+     * abbreviated view descriptions.
+     * @param {Date} date The date to format.
+     * @returns {string} The formatted date.
+     */
+    shortDateTimeFormat ? : string|((date: Date) => string)
+    /**
+     * The class name to add to events which have duration less than or equal to
+     * [shortEventDuration](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-shortEventDuration).
+     */
+    shortEventCls ? : string
+    /**
+     * The duration at which below and equal to this value, an event's encapsulating element gets
+     * the [shortEventCls](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-shortEventCls) added to it so that small event bars can have style rearrangements.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-shortEventDuration)
+     */
+    shortEventDuration ? : string|number
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-showAnimation)
+     */
+    showAnimation ? : Boolean|object
+    /**
+     * <strong>Not applicable in a `DayView`</strong>
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-showBullet)
+     * @param {boolean} bar This is `false` by default. Set this to `true` in modes where a solid event bar should show a bullet icon
+     * @param {boolean} noBar This is `true` by default. Events with no background colour, use this to show the event's defined `eventColor`
+     */
+    showBullet ? : Boolean|{bar?: Boolean, noBar?: Boolean}
+    /**
+     * 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:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-showEvents)
+     */
+    showEvents ? : Boolean|'heatmap'|'dots'
+    /**
+     * Configure as `true` to show avatars of the assigned resources (calendars) at the
+     * start of the event bar.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-showResourceAvatars)
+     */
+    showResourceAvatars ? : Boolean|string
+    /**
+     * Set to `false` to not show the tooltip when this widget is [disabled](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-disabled)
+     */
+    showTooltipWhenDisabled ? : Boolean
+    /**
+     * By default, all months show six week rows. Pass `false` to only render as many rows
+     * as needed.
+     */
+    sixWeeks ? : Boolean
+    /**
+     * Programmatic control over how many columns to span when used in a grid layout.
+     */
+    span ? : number
+    /**
+     * Set to `true` to stack multi-day events within each cell in the order of their start time.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-stackMultiDayEvents)
+     */
+    stackMultiDayEvents ? : Boolean
+    /**
+     * This value can be one of the following:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-stateful)
+     */
+    stateful ? : Boolean|object|string[]
+    /**
+     * The events that, when fired by this component, should trigger it to save its state by calling
+     * [saveState](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#function-saveState).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-statefulEvents)
+     */
+    statefulEvents ? : object|string[]
+    /**
+     * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateProvider). If this config is
+     * not assigned, and [stateful](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
+     * (if explicitly specified) will be used as the `stateId`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-stateId)
+     */
+    stateId ? : string
+    /**
+     * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#property-state). By default, `state`
+     * will be saved using the [default state provider](https://bryntum.com/products/calendar/docs/api/Core/state/StateProvider#property-instance-static).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-stateProvider)
+     */
+    stateProvider ? : StateProvider
+    /**
+     * Specify `true` to match fields by their `name` property only when assigning a [record](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-record),
+     * without falling back to `ref`.
+     */
+    strictRecordMapping ? : Boolean
+    /**
+     * An object containing widgets keyed by name. By default (when no `type` is given), strips are
+     * [toolbars](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
+     * the toolbar's [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-strips)
+     */
+    strips ? : Record<string, ContainerItemConfig>
+    /**
+     * The converse of [syncViewDate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#property-syncViewDate)
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-syncCalendarDate)
+     */
+    syncCalendarDate ? : Boolean
+    /**
+     * The converse of [syncCalendarDate](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#property-syncCalendarDate)
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-syncViewDate)
+     */
+    syncViewDate ? : Boolean
+    /**
+     * A configuration for the [tab](https://bryntum.com/products/calendar/docs/api/Core/widget/Tab) created for this widget when it is placed in a
+     * [TabPanel](https://bryntum.com/products/calendar/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
+     * this widget:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-tab)
+     */
+    tab ? : Boolean|TabConfig
+    /**
+     * When this container is used as a tab in a TabPanel, these items are added to the
+     * [TabBar](https://bryntum.com/products/calendar/docs/api/Core/widget/TabBar) when this container is the active tab.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-tabBarItems)
+     */
+    tabBarItems ? : ToolbarItems[]|Widget[]
+    /**
+     * The tag name of this Widget's root element
+     */
+    tag ? : string
+    /**
+     * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
+     * or array of config objects representing the child items of a Toolbar.
+     * This creates a toolbar docked to the top of the panel immediately below the header.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-tbar)
+     */
+    tbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
+    /**
+     * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-textAlign)
+     */
+    textAlign ? : 'left'|'center'|'right'|'start'|'end'
+    /**
+     * A [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string/function used to format the time displayed in events
+     * @param {Date} date The date to format.
+     * @returns {string} The formatted date.
+     */
+    timeFormat ? : string|((date: Date) => string)
+    /**
+     * A title to display in the header or owning TabPanel. Causes creation and docking of a header
+     * to the top if no header is configured.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-title)
+     */
+    title ? : string
+    /**
+     * The [tools](https://bryntum.com/products/calendar/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
+     * property name is the reference by which an instantiated tool may be retrieved from the live
+     * `[tools](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-tools)
+     */
+    tools ? : Record<string, ToolConfig>|null
+    /**
+     * Tooltip for the widget, either as a string or as a Tooltip config object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-tooltip)
+     */
+    tooltip ? : string|TooltipConfig|null
+    /**
+     * By default, tabbing within a Panel is not contained, ie you can TAB out of the Panel
+     * forwards or backwards.
+     * Configure this as `true` to disallow tabbing out of the Panel, and make tabbing circular within this Panel.
+     */
+    trapFocus ? : Boolean
+    type ? : 'yearview'|'year'
+    /**
+     * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
+     * as a space separated string, an array of strings, or as an object in which property names with truthy
+     * values are used as the class names.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-ui)
+     */
+    ui ? : 'plain'|'toolbar'|string|object
+    /**
+     * The week start day, 0 meaning Sunday, 6 meaning Saturday.
+     * Defaults to [weekStartDay](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper#property-weekStartDay-static).
+     */
+    weekStartDay ? : number
+    /**
+     * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/calendar/docs/api/Core/widget/Container).
+     * Higher weights go further down.
+     */
+    weight ? : number
+    /**
+     * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
+     * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
+     * this config is convenient.
+     */
+    width ? : string|number
+    /**
+     * The x position for the widget.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-x)
+     */
+    x ? : number
+    /**
+     * The y position for the widget.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/YearView#config-y)
+     */
+    y ? : number
+    /**
+     * The year to display
+     */
+    year ? : number
+
+}