MultiDatePicker

This widget allows date selection presented across multiple date pickers. The API matches closely to a DatePicker since the only meaningful difference in functionality is the use of a carousel to present multiple months at the same time. This widget is a part of DateRangePicker.

This widget is not intended to be used directly

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

baseDate : Date

internal

The date that corresponds to carousel slot index 0.
cellRenderer : Function/String
A function (or the name of a function) which creates content in, and may mutate a day cell element.

See cellRenderer.
Parameters
- context : Object
  
  Renderer context data
- cell : HTMLElement
  
  The header element
- date : Date
  
  The date for the cell
- day : Number
  
  The day for the cell (0 to 6 for Sunday to Saturday)
- rowIndex : Number[]
  
  The row index, 0 to month row count
- row : HTMLElement
  
  The row element encapsulating the week which the cell is a part of
- source : CalendarPanel
  
  The widget being rendered
- cellIndex : Number[]
  
  The cell index in the whole panel. May be from 0 to up to 42
- columnIndex : Number[]
  
  The column index, 0 to 6
- visibleColumnIndex : Number[]
  
  The visible column index taking hidden non-working days into account
Returns

String/DomConfig/null
date : Date

The initially selected date.
datePickerDefaults : DatePickerConfig

The configuration defaults for all date pickers in the carousel.
headerRenderer : Function/String
A function (or the name of a function) which creates content in, and may mutate a day header element.

See headerRenderer.
Parameters
- context : Object
  
  Renderer context data
- cell : HTMLElement
  
  The header element
- day : Number
  
  The day number conforming to the specified weekStartDay. Will be in the range 0 to 6
- weekDay : Number
  
  The canonical day number where Monday is 0 and Sunday is
Returns

String/DomConfig/null
includeYear : Function

internal
Set to false to hide the year indicator field, or a function that accepts a Date and returns the desired visibility of the year field (true or false).
Parameters
- date : Date
  
  The Date to evaluate when includeYear is a function
Returns

Boolean
:

Return true to include the year indicator, false to hide it.
maxDate : Date

The maximum selectable date. Selection of and navigation to dates after this date will not be possible.
minDate : Date

The minimum selectable date. Selection of and navigation to dates prior to this date will not be possible.
multiSelect : Boolean/'range'false

Configure as true to enable selecting multiple discontiguous date ranges using click and Shift+click to create ranges and Ctrl+click to select/deselect individual dates.

Configure as 'range' to enable selecting a single date range by selecting a start and end date. Hold "SHIFT" button to select date range. Ctrl+click may add or remove dates to/from either end of the range.

Set to false to not allow multiple date selection.
navButtons : Boolean/'inline'/'floating'true

Set to false to hide the next and previous month buttons.
selection : Date[]

The current date range selection as an array of two Date objects.

Has a corresponding runtime selection property.
weekRenderer : Function/String
A function (or the name of a function) which creates content in, and may mutate the week cell element at the start of a week row.

See weekRenderer.
Parameters
- context : Object
  
  Renderer context data
- cell : HTMLElement
  
  The header element
- week : Number[]
  
  An array containing [year, weekNumber]
Returns

String/DomConfig/null
weekStartDay : Number

The week start day, 0 meaning Sunday, 6 meaning Saturday. Defaults to weekStartDay.

Properties

Properties are getters/setters or publicly accessible variables on this class

isMultiDatePicker : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of MultiDatePicker class, or subclass thereof.

datePickers : DatePicker[]

internal

READONLY

Returns all date picker child widgets.
selection : Date[]

The current date range selection as an array of two Date objects.

Has a corresponding selection config.
isMultiDatePicker : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of MultiDatePicker class, or subclass thereof.

Functions

Functions are methods available for calling on the class

ensurePlan( options )

internal

Decodes the options passed to ensureVisible and ensures the object has the properties needed by ensureVisible.
ensureVisible( options )

Ensures that the given slot date is visible, scrolling if necessary to make it so.
syncSelection( origin, selection )

internal

Synchronizes the selection config with each date pickers' selection.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

selectionChange

Fires when a date or date range is selected. If multiSelect is specified, this will fire upon deselection and selection of dates.

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onSelectionChange

Called when a date or date range is selected. If multiSelect is specified, this will fire upon deselection and selection of dates.

Source path

Core/widget/MultiDatePicker.js

MultiDatePicker

Configs

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties

Functions

Events

Event handlers

Source path

Inheritance tree6

Mixins7

Contents