js-year-calendar
Version:
A fully customizable year calendar widget
931 lines • 59.4 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CalendarOptions | js-year-calendar</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">js-year-calendar</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="calendaroptions.html">CalendarOptions</a>
</li>
</ul>
<h1>Interface CalendarOptions<T></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Options used for calendar customization.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="calendardatasourceelement.html" class="tsd-signature-type">CalendarDataSourceElement</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">CalendarOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#allowoverlap" class="tsd-kind-icon">allow<wbr>Overlap</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#alwayshalfday" class="tsd-kind-icon">always<wbr>Half<wbr>Day</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#clickday" class="tsd-kind-icon">click<wbr>Day</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#contextmenuitems" class="tsd-kind-icon">context<wbr>Menu<wbr>Items</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#customdatasourcerenderer" class="tsd-kind-icon">custom<wbr>Data<wbr>Source<wbr>Renderer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#customdayrenderer" class="tsd-kind-icon">custom<wbr>Day<wbr>Renderer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#datasource" class="tsd-kind-icon">data<wbr>Source</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#daycontextmenu" class="tsd-kind-icon">day<wbr>Context<wbr>Menu</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#disableddays" class="tsd-kind-icon">disabled<wbr>Days</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#disabledweekdays" class="tsd-kind-icon">disabled<wbr>Week<wbr>Days</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#displaydisableddatasource" class="tsd-kind-icon">display<wbr>Disabled<wbr>Data<wbr>Source</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#displayheader" class="tsd-kind-icon">display<wbr>Header</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#displayweeknumber" class="tsd-kind-icon">display<wbr>Week<wbr>Number</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#enablecontextmenu" class="tsd-kind-icon">enable<wbr>Context<wbr>Menu</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#enablerangeselection" class="tsd-kind-icon">enable<wbr>Range<wbr>Selection</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#hiddenweekdays" class="tsd-kind-icon">hidden<wbr>Week<wbr>Days</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#language" class="tsd-kind-icon">language</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#loadingtemplate" class="tsd-kind-icon">loading<wbr>Template</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#maxdate" class="tsd-kind-icon">max<wbr>Date</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#mindate" class="tsd-kind-icon">min<wbr>Date</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#mouseonday" class="tsd-kind-icon">mouse<wbr>OnDay</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#mouseoutday" class="tsd-kind-icon">mouse<wbr>Out<wbr>Day</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#renderend" class="tsd-kind-icon">render<wbr>End</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#roundrangelimits" class="tsd-kind-icon">round<wbr>Range<wbr>Limits</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#selectrange" class="tsd-kind-icon">select<wbr>Range</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#startyear" class="tsd-kind-icon">start<wbr>Year</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#style" class="tsd-kind-icon">style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#weekstart" class="tsd-kind-icon">week<wbr>Start</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendaroptions.html#yearchanged" class="tsd-kind-icon">year<wbr>Changed</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="allowoverlap" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Overlap</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Overlap<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L16">interfaces/CalendarOptions.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the user can select a range which overlapping an other element present in the datasource.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="alwayshalfday" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Half<wbr>Day</h3>
<div class="tsd-signature tsd-kind-icon">always<wbr>Half<wbr>Day<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L21">interfaces/CalendarOptions.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the beginning and the end of each range should be displayed as half selected day.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="clickday" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> click<wbr>Day</h3>
<div class="tsd-signature tsd-kind-icon">click<wbr>Day<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L140">interfaces/CalendarOptions.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when a day is clicked.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="contextmenuitems" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> context<wbr>Menu<wbr>Items</h3>
<div class="tsd-signature tsd-kind-icon">context<wbr>Menu<wbr>Items<span class="tsd-signature-symbol">:</span> <a href="calendarcontextmenuitem.html" class="tsd-signature-type">CalendarContextMenuItem</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L26">interfaces/CalendarOptions.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies the items of the default context menu.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="customdatasourcerenderer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> custom<wbr>Data<wbr>Source<wbr>Renderer</h3>
<div class="tsd-signature tsd-kind-icon">custom<wbr>Data<wbr>Source<wbr>Renderer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, currentDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span>, events<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L44">interfaces/CalendarOptions.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specify a custom renderer for data source. Works only with the style set to "custom".</p>
</div>
<p>The HTML Element passed in parameter represent a sub element of the "day" div. If you need to access the "day" div, use <code>element.parentElement</code>.</p>
<p>This function is called during render for each day containing at least one event.</p>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, currentDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span>, events<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>element: <span class="tsd-signature-type">HTMLElement</span></h5>
</li>
<li>
<h5>currentDate: <span class="tsd-signature-type">Date</span></h5>
</li>
<li>
<h5>events: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="customdayrenderer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> custom<wbr>Day<wbr>Renderer</h3>
<div class="tsd-signature tsd-kind-icon">custom<wbr>Day<wbr>Renderer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, currentDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L35">interfaces/CalendarOptions.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specify a custom renderer for days.</p>
</div>
<p>The HTML Element passed in parameter represent a sub element of the "day" div. If you need to access the "day" div, use <code>element.parentElement</code>.</p>
<p>This function is called during render for each day.</p>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, currentDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>element: <span class="tsd-signature-type">HTMLElement</span></h5>
</li>
<li>
<h5>currentDate: <span class="tsd-signature-type">Date</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="datasource" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> data<wbr>Source</h3>
<div class="tsd-signature tsd-kind-icon">data<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>currentYear<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>currentYear<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, done<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L55">interfaces/CalendarOptions.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The elements that must be displayed on the calendar.</p>
</div>
<p>Could be:</p>
<ul>
<li>The datasource</li>
<li>A function that returns the datasource</li>
<li>An async function that will call the callback function with the datasource</li>
<li>An async function that returns a Promise to get the datasource</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="daycontextmenu" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> day<wbr>Context<wbr>Menu</h3>
<div class="tsd-signature tsd-kind-icon">day<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L145">interfaces/CalendarOptions.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when a day is right clicked.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="disableddays" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> disabled<wbr>Days</h3>
<div class="tsd-signature tsd-kind-icon">disabled<wbr>Days<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L60">interfaces/CalendarOptions.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The days that must be displayed as disabled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="disabledweekdays" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> disabled<wbr>Week<wbr>Days</h3>
<div class="tsd-signature tsd-kind-icon">disabled<wbr>Week<wbr>Days<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L65">interfaces/CalendarOptions.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The days of the week that must be displayed as disabled (0 for Sunday, 1 for Monday, etc.).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="displaydisableddatasource" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr>Disabled<wbr>Data<wbr>Source</h3>
<div class="tsd-signature tsd-kind-icon">display<wbr>Disabled<wbr>Data<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L75">interfaces/CalendarOptions.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the data source must be rendered on disabled days.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="displayheader" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr>Header</h3>
<div class="tsd-signature tsd-kind-icon">display<wbr>Header<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L85">interfaces/CalendarOptions.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the calendar header is displayed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="displayweeknumber" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr>Week<wbr>Number</h3>
<div class="tsd-signature tsd-kind-icon">display<wbr>Week<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L80">interfaces/CalendarOptions.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the weeks number are displayed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="enablecontextmenu" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Context<wbr>Menu</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L90">interfaces/CalendarOptions.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the default context menu must be displayed when right clicking on a day.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="enablerangeselection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Range<wbr>Selection</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Range<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L95">interfaces/CalendarOptions.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the range selection is enabled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="hiddenweekdays" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hidden<wbr>Week<wbr>Days</h3>
<div class="tsd-signature tsd-kind-icon">hidden<wbr>Week<wbr>Days<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L70">interfaces/CalendarOptions.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The days of the week that must not be displayed (0 for Sunday, 1 for Monday, etc.).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="language" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> language</h3>
<div class="tsd-signature tsd-kind-icon">language<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L100">interfaces/CalendarOptions.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The language/culture used for calendar rendering.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="loadingtemplate" class="tsd-anchor"></a>
<h3>loading<wbr>Template</h3>
<div class="tsd-signature tsd-kind-icon">loading<wbr>Template<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L105">interfaces/CalendarOptions.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTML used to render the loading component.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="maxdate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Date</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L110">interfaces/CalendarOptions.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The date until which days are enabled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="mindate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Date</h3>
<div class="tsd-signature tsd-kind-icon">min<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L115">interfaces/CalendarOptions.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The date from which days are enabled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="mouseonday" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> mouse<wbr>OnDay</h3>
<div class="tsd-signature tsd-kind-icon">mouse<wbr>OnDay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L150">interfaces/CalendarOptions.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when the mouse enter on a day.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="mouseoutday" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> mouse<wbr>Out<wbr>Day</h3>
<div class="tsd-signature tsd-kind-icon">mouse<wbr>Out<wbr>Day<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L155">interfaces/CalendarOptions.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when the mouse leaves a day.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="renderend" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> render<wbr>End</h3>
<div class="tsd-signature tsd-kind-icon">render<wbr>End<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendarrenderendeventobject.html" class="tsd-signature-type">CalendarRenderEndEventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L160">interfaces/CalendarOptions.ts:160</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when the calendar rendering is ended.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendarrenderendeventobject.html" class="tsd-signature-type">CalendarRenderEndEventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendarrenderendeventobject.html" class="tsd-signature-type">CalendarRenderEndEventObject</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="roundrangelimits" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> round<wbr>Range<wbr>Limits</h3>
<div class="tsd-signature tsd-kind-icon">round<wbr>Range<wbr>Limits<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L120">interfaces/CalendarOptions.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether the beginning and the end of each range should be displayed as rounded cells.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="selectrange" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> select<wbr>Range</h3>
<div class="tsd-signature tsd-kind-icon">select<wbr>Range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendarrangeeventobject.html" class="tsd-signature-type">CalendarRangeEventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L165">interfaces/CalendarOptions.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when a date range is selected.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendarrangeeventobject.html" class="tsd-signature-type">CalendarRangeEventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendarrangeeventobject.html" class="tsd-signature-type">CalendarRangeEventObject</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="startyear" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> start<wbr>Year</h3>
<div class="tsd-signature tsd-kind-icon">start<wbr>Year<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L125">interfaces/CalendarOptions.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The year on which the calendar should be opened.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="style" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> style</h3>
<div class="tsd-signature tsd-kind-icon">style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L130">interfaces/CalendarOptions.ts:130</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies the style used for displaying datasource ("background", "border" or "custom").</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="weekstart" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> week<wbr>Start</h3>
<div class="tsd-signature tsd-kind-icon">week<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L135">interfaces/CalendarOptions.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The starting day of the week. This option overrides the parameter define in the language file.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="yearchanged" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> year<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">year<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendaryearchangedeventobject.html" class="tsd-signature-type">CalendarYearChangedEventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/interfaces/CalendarOptions.ts#L170">interfaces/CalendarOptions.ts:170</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function fired when the visible year of the calendar is changed.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="calendaryearchangedeventobject.html" class="tsd-signature-type">CalendarYearChangedEventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="calendaryearchangedeventobject.html" class="tsd-signature-type">CalendarYearChangedEventObject</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="../classes/calendar.html" class="tsd-kind-icon">Calendar</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="calendarcontextmenuitem.html" class="tsd-kind-icon">Calendar<wbr>Context<wbr>Menu<wbr>Item</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="calendardatasourceelement.html" class="tsd-kind-icon">Calendar<wbr>Data<wbr>Source<wbr>Element</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="calendardayeventobject.html" class="tsd-kind-icon">Calendar<wbr>Day<wbr>Event<wbr>Object</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="calendaroptions.html" class="tsd-kind-icon">Calendar<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#allowoverlap" class="tsd-kind-icon">allow<wbr>Overlap</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#alwayshalfday" class="tsd-kind-icon">always<wbr>Half<wbr>Day</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#clickday" class="tsd-kind-icon">click<wbr>Day</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#contextmenuitems" class="tsd-kind-icon">context<wbr>Menu<wbr>Items</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#customdatasourcerenderer" class="tsd-kind-icon">custom<wbr>Data<wbr>Source<wbr>Renderer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#customdayrenderer" class="tsd-kind-icon">custom<wbr>Day<wbr>Renderer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#datasource" class="tsd-kind-icon">data<wbr>Source</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#daycontextmenu" class="tsd-kind-icon">day<wbr>Context<wbr>Menu</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#disableddays" class="tsd-kind-icon">disabled<wbr>Days</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#disabledweekdays" class="tsd-kind-icon">disabled<wbr>Week<wbr>Days</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#displaydisableddatasource" class="tsd-kind-icon">display<wbr>Disabled<wbr>Data<wbr>Source</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#displayheader" class="tsd-kind-icon">display<wbr>Header</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#displayweeknumber" class="tsd-kind-icon">display<wbr>Week<wbr>Number</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#enablecontextmenu" class="tsd-kind-icon">enable<wbr>Context<wbr>Menu</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#enablerangeselection" class="tsd-kind-icon">enable<wbr>Range<wbr>Selection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#hiddenweekdays" class="tsd-kind-icon">hidden<wbr>Week<wbr>Days</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#language" class="tsd-kind-icon">language</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#loadingtemplate" class="tsd-kind-icon">loading<wbr>Template</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#maxdate" class="tsd-kind-icon">max<wbr>Date</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#mindate" class="tsd-kind-icon">min<wbr>Date</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#mouseonday" class="tsd-kind-icon">mouse<wbr>OnDay</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#mouseoutday" class="tsd-kind-icon">mouse<wbr>Out<wbr>Day</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#renderend" class="tsd-kind-icon">render<wbr>End</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#roundrangelimits" class="tsd-kind-icon">round<wbr>Range<wbr>Limits</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#selectrange" class="tsd-kind-icon">select<wbr>Range</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#startyear" class="tsd-kind-icon">start<wbr>Year</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#style" class="tsd-kind-icon">style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#weekstart" class="tsd-kind-icon">week<wbr>Start</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="calendaroptions.html#yearchanged" class="tsd-kind-icon">year<wbr>Changed</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-is-external">
<a href="calendarrangeeventobject.html" class="tsd-kind-icon">Calendar<wbr>Range<wbr>Event<wbr>Object</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="calendarrenderendeventobject.html" class="tsd-kind-icon">Calendar<wbr>Render<wbr>End<wbr>Event<wbr>Object</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="calendaryearchangedeventobject.html" class="tsd-kind-icon">Calendar<wbr>Year<wbr>Changed<wbr>Event<wbr>Object</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>