v7.3.0

Describable
Mixin

Mixin that provides a consistent method for describing the ranges of time presented by a view. This is currently consumed only by the Calendar widget for describing its child views. This mixin is defined here to facilitate using a Scheduler as a child view of a Calendar.

See also

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class
  • A string used to separate start and end dates in the descriptionFormat.

    Has a corresponding runtime dateSeparator property.

Properties

Properties are getters/setters or publicly accessible variables on this class
  • dateBounds : Date[]
    internal

    Returns the date or ranges of included dates as an array. If there is only one significant date, the array will have only one element. Otherwise, a range of dates is returned as a two-element array with [0] being the startDate and [1] the lastDate.

  • dateFormat : String/FunctionMMMM d, YYYY

    A DateHelper format string/function to use to create date output for view descriptions.

    Has a corresponding dateFormat config.

  • A string used to separate start and end dates in the descriptionFormat.

    Has a corresponding dateSeparator config.

  • description : String
    READONLY

    The textual description generated by the descriptionRenderer if present, or by the view's date (or date range if it has a range) and the descriptionFormat.

  • isDescribable : Booleantrue
    READONLY
    ADVANCED
    Identifies an object as an instance of Describable class, or subclass thereof.

Source path

Scheduler/view/mixin/Describable.js

Contents