UNPKG

js-year-calendar

Version:

A fully customizable year calendar widget

221 lines 9.43 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>CalendarDayEventObject | 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="calendardayeventobject.html">CalendarDayEventObject</a> </li> </ul> <h1>Interface CalendarDayEventObject&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-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">CalendarDayEventObject</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="calendardayeventobject.html#date" class="tsd-kind-icon">date</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendardayeventobject.html#element" class="tsd-kind-icon">element</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="calendardayeventobject.html#events" class="tsd-kind-icon">events</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="date" class="tsd-anchor"></a> <h3>date</h3> <div class="tsd-signature tsd-kind-icon">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/CalendarDayEventObject.ts#L12">interfaces/CalendarDayEventObject.ts:12</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The fired date.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="element" class="tsd-anchor"></a> <h3>element</h3> <div class="tsd-signature tsd-kind-icon">element<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/CalendarDayEventObject.ts#L7">interfaces/CalendarDayEventObject.ts:7</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The element that contain the fired day.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="events" class="tsd-anchor"></a> <h3>events</h3> <div class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</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/CalendarDayEventObject.ts#L17">interfaces/CalendarDayEventObject.ts:17</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The data source elements present on the fired day.</p> </div> </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> </ul> <ul class="current"> <li class="current 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> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="calendardayeventobject.html#date" class="tsd-kind-icon">date</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="calendardayeventobject.html#element" class="tsd-kind-icon">element</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="calendardayeventobject.html#events" class="tsd-kind-icon">events</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external"> <a href="calendaroptions.html" class="tsd-kind-icon">Calendar<wbr>Options</a> </li> <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>