API Docs for: 0.0.2
Show:

calendar.Calendar Class

Extends calendar.Base
Defined in: api/src/calendar/calendar.js:1
Module: calendar

Methods

getDate

() Object

Defined in api/src/calendar/calendar.js:80

Returns selected date as Date object

Returns:

Object: selected date

getValue

() String

Defined in api/src/calendar/calendar.js:88

Returns selected date

Returns:

String: selected date

setMonth

(
  • month
)

Defined in api/src/calendar/calendar.js:106

Set current month

Parameters:

Returns:

void

setValue

(
  • date
)

Defined in api/src/calendar/calendar.js:96

Set new current date

Parameters:

setYear

(
  • year
)

Defined in api/src/calendar/calendar.js:60

Set year (4 digits)

Parameters:

Attributes

date

String

Defined in api\src\calendar\calendar.js:29

Initial date, example: '2012-02-28', "date" is alias to "value"

Fires event dateChange

Fires when the value for the configuration attribute date is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

inputFormat

String

Defined in api\src\calendar\calendar.js:22

Default: Y-m-d

Fires event inputFormatChange

Fires when the value for the configuration attribute inputFormat is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

maxDate

String

Defined in api\src\calendar\calendar.js:41

maximum valid date, eg. '2013-01-01'

Fires event maxDateChange

Fires when the value for the configuration attribute maxDate is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

minDate

String

Defined in api\src\calendar\calendar.js:36

minimum valid date, eg. '2011-01-01'

Fires event minDateChange

Fires when the value for the configuration attribute minDate is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.