UNPKG

js-year-calendar

Version:

A fully customizable year calendar widget

721 lines 134 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Calendar | 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="calendar.html">Calendar</a> </li> </ul> <h1>Class Calendar&lt;T&gt;</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>Calendar instance.</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="../interfaces/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">Calendar</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 "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="calendar.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Events</h3> <ul class="tsd-index-list"> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#clickday" class="tsd-kind-icon">click<wbr>Day</a></li> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#daycontextmenu" class="tsd-kind-icon">day<wbr>Context<wbr>Menu</a></li> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#mouseonday" class="tsd-kind-icon">mouse<wbr>OnDay</a></li> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#mouseoutday" class="tsd-kind-icon">mouse<wbr>Out<wbr>Day</a></li> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#renderend" class="tsd-kind-icon">render<wbr>End</a></li> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#selectrange" class="tsd-kind-icon">select<wbr>Range</a></li> <li class="tsd-kind-event tsd-parent-kind-class"><a href="calendar.html#yearchanged" class="tsd-kind-icon">year<wbr>Changed</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#addevent" class="tsd-kind-icon">add<wbr>Event</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getallowoverlap" class="tsd-kind-icon">get<wbr>Allow<wbr>Overlap</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getalwayshalfday" class="tsd-kind-icon">get<wbr>Always<wbr>Half<wbr>Day</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getcontextmenuitems" class="tsd-kind-icon">get<wbr>Context<wbr>Menu<wbr>Items</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getcustomdatasourcerenderer" class="tsd-kind-icon">get<wbr>Custom<wbr>Data<wbr>Source<wbr>Renderer</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getcustomdayrenderer" class="tsd-kind-icon">get<wbr>Custom<wbr>Day<wbr>Renderer</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getdatasource" class="tsd-kind-icon">get<wbr>Data<wbr>Source</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getdisableddays" class="tsd-kind-icon">get<wbr>Disabled<wbr>Days</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getdisabledweekdays" class="tsd-kind-icon">get<wbr>Disabled<wbr>Week<wbr>Days</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getdisplaydisableddatasource" class="tsd-kind-icon">get<wbr>Display<wbr>Disabled<wbr>Data<wbr>Source</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getdisplayheader" class="tsd-kind-icon">get<wbr>Display<wbr>Header</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getdisplayweeknumber" class="tsd-kind-icon">get<wbr>Display<wbr>Week<wbr>Number</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getenablecontextmenu" class="tsd-kind-icon">get<wbr>Enable<wbr>Context<wbr>Menu</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getenablerangeselection" class="tsd-kind-icon">get<wbr>Enable<wbr>Range<wbr>Selection</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getevents" class="tsd-kind-icon">get<wbr>Events</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#geteventsonrange" class="tsd-kind-icon">get<wbr>Events<wbr>OnRange</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#gethiddenweekdays" class="tsd-kind-icon">get<wbr>Hidden<wbr>Week<wbr>Days</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getlanguage" class="tsd-kind-icon">get<wbr>Language</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getloadingtemplate" class="tsd-kind-icon">get<wbr>Loading<wbr>Template</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getmaxdate" class="tsd-kind-icon">get<wbr>Max<wbr>Date</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getmindate" class="tsd-kind-icon">get<wbr>Min<wbr>Date</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getroundrangelimits" class="tsd-kind-icon">get<wbr>Round<wbr>Range<wbr>Limits</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getstyle" class="tsd-kind-icon">get<wbr>Style</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getweeknumber" class="tsd-kind-icon">get<wbr>Week<wbr>Number</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getweekstart" class="tsd-kind-icon">get<wbr>Week<wbr>Start</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#getyear" class="tsd-kind-icon">get<wbr>Year</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#istherefreeslot" class="tsd-kind-icon">is<wbr>There<wbr>Free<wbr>Slot</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#render" class="tsd-kind-icon">render</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setallowoverlap" class="tsd-kind-icon">set<wbr>Allow<wbr>Overlap</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setalwayshalfday" class="tsd-kind-icon">set<wbr>Always<wbr>Half<wbr>Day</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setcontextmenuitems" class="tsd-kind-icon">set<wbr>Context<wbr>Menu<wbr>Items</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setcustomdatasourcerenderer" class="tsd-kind-icon">set<wbr>Custom<wbr>Data<wbr>Source<wbr>Renderer</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setcustomdayrenderer" class="tsd-kind-icon">set<wbr>Custom<wbr>Day<wbr>Renderer</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setdatasource" class="tsd-kind-icon">set<wbr>Data<wbr>Source</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setdisableddays" class="tsd-kind-icon">set<wbr>Disabled<wbr>Days</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setdisabledweekdays" class="tsd-kind-icon">set<wbr>Disabled<wbr>Week<wbr>Days</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setdisplaydisableddatasource" class="tsd-kind-icon">set<wbr>Display<wbr>Disabled<wbr>Data<wbr>Source</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setdisplayheader" class="tsd-kind-icon">set<wbr>Display<wbr>Header</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setdisplayweeknumber" class="tsd-kind-icon">set<wbr>Display<wbr>Week<wbr>Number</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setenablecontextmenu" class="tsd-kind-icon">set<wbr>Enable<wbr>Context<wbr>Menu</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setenablerangeselection" class="tsd-kind-icon">set<wbr>Enable<wbr>Range<wbr>Selection</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#sethiddenweekdays" class="tsd-kind-icon">set<wbr>Hidden<wbr>Week<wbr>Days</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setlanguage" class="tsd-kind-icon">set<wbr>Language</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setloadingtemplate" class="tsd-kind-icon">set<wbr>Loading<wbr>Template</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setmaxdate" class="tsd-kind-icon">set<wbr>Max<wbr>Date</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setmindate" class="tsd-kind-icon">set<wbr>Min<wbr>Date</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setroundrangelimits" class="tsd-kind-icon">set<wbr>Round<wbr>Range<wbr>Limits</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setstyle" class="tsd-kind-icon">set<wbr>Style</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setweekstart" class="tsd-kind-icon">set<wbr>Week<wbr>Start</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="calendar.html#setyear" class="tsd-kind-icon">set<wbr>Year</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Calendar<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/calendaroptions.html" class="tsd-signature-type">CalendarOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="calendar.html" class="tsd-signature-type">Calendar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L174">js-year-calendar.ts:174</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create a new calendar.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>element: <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The element (or the selector to an element) in which the calendar should be created.</p> </div> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/calendaroptions.html" class="tsd-signature-type">CalendarOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = null</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The options used to customize the calendar</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="calendar.html" class="tsd-signature-type">Calendar</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Events</h2> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="clickday" class="tsd-anchor"></a> <h3>click<wbr>Day</h3> <div class="tsd-signature tsd-kind-icon">click<wbr>Day<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L94">js-year-calendar.ts:94</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fired when a day is clicked.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> document.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'clickDay'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(e)</span> {</span> console.<span class="hljs-built_in">log</span>(<span class="hljs-string">"Click on day: "</span> + e.date + <span class="hljs-string">" ("</span> + e.<span class="hljs-keyword">events</span>.<span class="hljs-built_in">length</span> + <span class="hljs-string">" events)"</span>); })</code></pre></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="daycontextmenu" class="tsd-anchor"></a> <h3>day<wbr>Context<wbr>Menu</h3> <div class="tsd-signature tsd-kind-icon">day<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L107">js-year-calendar.ts:107</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fired when a day is right clicked.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> document.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'clickDay'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(e)</span> {</span> console.<span class="hljs-built_in">log</span>(<span class="hljs-string">"Right click on day: "</span> + e.date + <span class="hljs-string">" ("</span> + e.<span class="hljs-keyword">events</span>.<span class="hljs-built_in">length</span> + <span class="hljs-string">" events)"</span>); })</code></pre></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="mouseonday" class="tsd-anchor"></a> <h3>mouse<wbr>OnDay</h3> <div class="tsd-signature tsd-kind-icon">mouse<wbr>OnDay<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L120">js-year-calendar.ts:120</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fired when the mouse enter in a day.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> document.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'mouseOnDay'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(e)</span> {</span> console.<span class="hljs-built_in">log</span>(<span class="hljs-string">"Mouse enter in a day: "</span> + e.date + <span class="hljs-string">" ("</span> + e.<span class="hljs-keyword">events</span>.<span class="hljs-built_in">length</span> + <span class="hljs-string">" events)"</span>); })</code></pre></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="mouseoutday" class="tsd-anchor"></a> <h3>mouse<wbr>Out<wbr>Day</h3> <div class="tsd-signature tsd-kind-icon">mouse<wbr>Out<wbr>Day<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendardayeventobject.html" class="tsd-signature-type">CalendarDayEventObject</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L133">js-year-calendar.ts:133</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fired when the mouse leave a day.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> document.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'mouseOutDay'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(e)</span> {</span> console.<span class="hljs-built_in">log</span>(<span class="hljs-string">"Mouse leave a day: "</span> + e.date + <span class="hljs-string">" ("</span> + e.<span class="hljs-keyword">events</span>.<span class="hljs-built_in">length</span> + <span class="hljs-string">" events)"</span>); })</code></pre></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="renderend" class="tsd-anchor"></a> <h3>render<wbr>End</h3> <div class="tsd-signature tsd-kind-icon">render<wbr>End<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendarrenderendeventobject.html" class="tsd-signature-type">CalendarRenderEndEventObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L146">js-year-calendar.ts:146</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fired when the calendar rendering is ended.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'renderEnd'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">e</span>) </span>{ <span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Render end for year: "</span> + e.currentYear); })</code></pre></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="selectrange" class="tsd-anchor"></a> <h3>select<wbr>Range</h3> <div class="tsd-signature tsd-kind-icon">select<wbr>Range<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendarrangeeventobject.html" class="tsd-signature-type">CalendarRangeEventObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L161">js-year-calendar.ts:161</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fired when a date range is selected.</p> </div> <p>Don&#39;t forget to enable the <code>enableRangeSelection</code> option to be able to use the range selection functionality.</p> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'selectRange'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">e</span>) </span>{ <span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Select the range: "</span> + e.startDate + <span class="hljs-string">" - "</span> + e.endDate); })</code></pre></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"> <a name="yearchanged" class="tsd-anchor"></a> <h3>year<wbr>Changed</h3> <div class="tsd-signature tsd-kind-icon">year<wbr>Changed<span class="tsd-signature-symbol">:</span> <a href="../interfaces/calendaryearchangedeventobject.html" class="tsd-signature-type">CalendarYearChangedEventObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L174">js-year-calendar.ts:174</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Triggered after the changing the current year.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">'.calendar'</span>).addEventListener(<span class="hljs-string">'yearChanged'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">e</span>) </span>{ <span class="hljs-built_in">console</span>.log(<span class="hljs-string">"New year selected: "</span> + e.currentYear); })</code></pre></dd> </dl> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addevent" class="tsd-anchor"></a> <h3>add<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Event<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, preventRendering<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1813">js-year-calendar.ts:1813</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add a new element to the data source.</p> </div> <p>This method causes a refresh of the calendar.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>evt: <span class="tsd-signature-type">T</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> preventRendering: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> <div class="tsd-comment tsd-typography"> <p>Indicates whether the calendar shouldn&#39;t be refreshed once the event added.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getallowoverlap" class="tsd-anchor"></a> <h3>get<wbr>Allow<wbr>Overlap</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Allow<wbr>Overlap<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1392">js-year-calendar.ts:1392</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a value indicating whether the user can select a range which overlapping an other element present in the datasource.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getalwayshalfday" class="tsd-anchor"></a> <h3>get<wbr>Always<wbr>Half<wbr>Day</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Always<wbr>Half<wbr>Day<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1477">js-year-calendar.ts:1477</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a value indicating whether the beginning and the end of each range should be displayed as half selected day.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcontextmenuitems" class="tsd-anchor"></a> <h3>get<wbr>Context<wbr>Menu<wbr>Items</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Context<wbr>Menu<wbr>Items<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/calendarcontextmenuitem.html" class="tsd-signature-type">CalendarContextMenuItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1638">js-year-calendar.ts:1638</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the context menu items.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="../interfaces/calendarcontextmenuitem.html" class="tsd-signature-type">CalendarContextMenuItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcustomdatasourcerenderer" class="tsd-anchor"></a> <h3>get<wbr>Custom<wbr>Data<wbr>Source<wbr>Renderer</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Custom<wbr>Data<wbr>Source<wbr>Renderer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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"> =&gt; </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1684">js-year-calendar.ts:1684</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the custom data source renderer.</p> </div> </div> <h4 class="tsd-returns-title">Returns <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"> =&gt; </span><span class="tsd-signature-type">void</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <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> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcustomdayrenderer" class="tsd-anchor"></a> <h3>get<wbr>Custom<wbr>Day<wbr>Renderer</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Custom<wbr>Day<wbr>Renderer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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"> =&gt; </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1661">js-year-calendar.ts:1661</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the custom day renderer.</p> </div> </div> <h4 class="tsd-returns-title">Returns <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"> =&gt; </span><span class="tsd-signature-type">void</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <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> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdatasource" class="tsd-anchor"></a> <h3>get<wbr>Data<wbr>Source</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Data<wbr>Source<span class="tsd-signature-symbol">(</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-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"> =&gt; </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">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1732">js-year-calendar.ts:1732</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the current data source.</p> </div> </div> <h4 class="tsd-returns-title">Returns <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"> =&gt; </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">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdisableddays" class="tsd-anchor"></a> <h3>get<wbr>Disabled<wbr>Days</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Disabled<wbr>Days<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1523">js-year-calendar.ts:1523</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the disabled days.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdisabledweekdays" class="tsd-anchor"></a> <h3>get<wbr>Disabled<wbr>Week<wbr>Days</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Disabled<wbr>Week<wbr>Days<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1546">js-year-calendar.ts:1546</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the disabled days of the week.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdisplaydisableddatasource" class="tsd-anchor"></a> <h3>get<wbr>Display<wbr>Disabled<wbr>Data<wbr>Source</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Display<wbr>Disabled<wbr>Data<wbr>Source<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1454">js-year-calendar.ts:1454</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a value indicating whether the data source must be rendered on disabled days.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdisplayheader" class="tsd-anchor"></a> <h3>get<wbr>Display<wbr>Header</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Display<wbr>Header<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1431">js-year-calendar.ts:1431</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a value indicating whether the calendar header is displayed.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdisplayweeknumber" class="tsd-anchor"></a> <h3>get<wbr>Display<wbr>Week<wbr>Number</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Display<wbr>Week<wbr>Number<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1408">js-year-calendar.ts:1408</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a value indicating whether the weeks number are displayed.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getenablecontextmenu" class="tsd-anchor"></a> <h3>get<wbr>Enable<wbr>Context<wbr>Menu</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Enable<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/year-calendar/js-year-calendar/blob/561a8b3/src/ts/js-year-calendar.ts#L1615">js-year-calendar.ts:1615</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a value indicating whether the default context menu must be displayed when right clicking on a day.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a