[]
        
(Showing Draft Content)

Wijmo_Angular2_Input.Wjcalendar

WjCalendar Class

Angular 2 component for the wijmo.input.Calendar control.

Use the wj-calendar component to add Calendar controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

The WjCalendar component is derived from the Calendar control and inherits all its properties, events and methods.

Heirarchy

Properties

asyncBindings

asyncBindings: boolean

Allows you to override the global WjOptions.asyncBindings setting for this specific component. See the WjOptions.WjOptions.asyncBindings property description for details.

displayMonth

displayMonth: Date

Gets or sets the month displayed in the calendar.

displayMonthChangePC

displayMonthChangePC: EventEmitter<any>

This event is used to implement two-way binding to the displayMonth property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the displayMonthChange event name.

displayMonthChangedNg

displayMonthChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo displayMonthChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional displayMonthChanged Wijmo event name.

firstDayOfWeek

firstDayOfWeek: number | null

Gets or sets a value that represents the first day of the week, the one displayed in the first column of the calendar.

The default value for this property is null, which causes the calendar to use the default for the current culture.

In the English culture, the first day of the week is Sunday (0); in most European cultures, the first day of the week is Monday (1).

formatDayHeaders

formatDayHeaders: string

Gets or sets the format used to display the headers above the days in month view.

The default value for this property is 'ddd'.

formatDays

formatDays: string

Gets or sets the format used to display the days in month view.

The default value for this property is 'd ' (the space after the 'd' prevents the format from being interpreted as 'd', the standard format used to represent the short date pattern).

formatItemNg

formatItemNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo formatItem event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional formatItem Wijmo event name.

formatMonths

formatMonths: string

Gets or sets the format used to display the months in year view.

The default value for this property is 'MMM'.

formatYear

formatYear: string

Gets or sets the format used to display the year above the months in year view.

The default value for this property is 'yyyy'.

formatYearMonth

formatYearMonth: string

Gets or sets the format used to display the month and year above the calendar in month view.

The default value for this property is 'y'.

gotFocusNg

gotFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo gotFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional gotFocus Wijmo event name.

handleWheel

handleWheel: boolean

Gets or sets a value that determines whether the user can change the current displayMonth using the mouse wheel.

The default value for this property is true.

hostElement

hostElement: HTMLElement

Gets the DOM element that is hosting the control.

initialized

initialized: EventEmitter<any>

This event is triggered after the component has been initialized by Angular, that is all bound properties have been assigned and child components (if any) have been initialized.

invalidInputNg

invalidInputNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo invalidInput event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional invalidInput Wijmo event name.

isDisabled

isDisabled: boolean

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.

isInitialized

isInitialized: boolean

Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.

isReadOnly

isReadOnly: boolean

Gets or sets a value that determines whether users can modify the control value using the mouse and keyboard.

The default value for this property is false.

isTouching

isTouching: boolean

Gets a value that indicates whether the control is currently handling a touch event.

isUpdating

isUpdating: boolean

Gets a value that indicates whether the control is currently being updated.

itemFormatter

itemFormatter: IDateFormatter | null

Gets or sets a formatter function to customize dates in the calendar.

The formatter function can add any content to any date. It allows complete customization of the appearance and behavior of the calendar.

If specified, the function takes two parameters:

  • the date being formatted
  • the HTML element that represents the date

For example, the code below shows weekends with a yellow background:

calendar.itemFormatter = (date, element) => {
    let day = date.getDay();
    element.style.backgroundColor = (day == 0 || day == 6) ? 'yellow' : '';
}

itemValidator

itemValidator: IDateValidator | null

Gets or sets a validator function to determine whether dates are valid for selection.

If specified, the validator function should take one parameter representing the date to be tested, and should return false if the date is invalid and should not be selectable.

For example, the code below shows weekends in a disabled state and prevents users from selecting those dates:

calendar.itemValidator = date => {
    let weekday = date.getDay();
    return weekday != 0 && weekday != 6;
}

lostFocusNg

lostFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo lostFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional lostFocus Wijmo event name.

max

max: Date | null

Gets or sets the latest date that the user can select in the calendar.

The default value for this property is null, which means no latest date is defined.

For details about using the min and max properties, please see the Using the min and max properties topic.

min

min: Date | null

Gets or sets the earliest date that the user can select in the calendar.

The default value for this property is null, which means no earliest date is defined.

For details about using the min and max properties, please see the Using the min and max properties topic.

monthCount

monthCount: number

Gets or sets the number of months to display within the calendar.

The default value for this property is 1.

When you set this property to a value greater than 1, extra child calendars are added to the control displaying consecutive months.

All calendars within the control are synchronized, so changing any property on the main calendar automatically updates all child calendars. This includes the value, rangeEnd, and selectionMode properties.

When multiple months are shown, the main control's host element gets a "wj-calendar-multimonth" class which is used in CSS to switch the display to "flex".

The "flex" container is very versatile. You can limit the width of the outer control and have the months wrap horizontally or vertically, align the months within the main control, align and justify them, etc.

monthView

monthView: boolean

Gets or sets a value that determines whether the calendar should display a month view (one day per cell) or a year view (one month per cell).

The default value for this property is true.

rangeChangedNg

rangeChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo rangeChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional rangeChanged Wijmo event name.

rangeEnd

rangeEnd: Date

Gets or sets the last selected date in a range selection.

To enable date range selection, set the selectionMode property to DateSelectionMode.Range.

Once you do that, the selection range will be defined by the value and rangeEnd properties.

If not null, the rangeEnd date must be greater than or equal to the value date, which represents the range start.

rangeEndChangePC

rangeEndChangePC: EventEmitter<any>

This event is used to implement two-way binding to the rangeEnd property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the rangeEndChange event name.

rangeEndChangedNg

rangeEndChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo rangeEndChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional rangeEndChanged Wijmo event name.

rangeMax

rangeMax: number

Gets or sets the maximum length allowed when editing date ranges.

This property is used only when the selectionMode property is set to DateSelectionMode.Range.

The default value for this property is 0, which means there is no maximum value for range lengths.

rangeMin

rangeMin: number

Gets or sets the minimum number of days allowed when editing date ranges.

This property is used only when the selectionMode property is set to DateSelectionMode.Range.

The default value for this property is 0, which means there is no minimum value for range lengths.

refreshedNg

refreshedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshed event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshed Wijmo event name.

refreshingNg

refreshingNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshing event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshing Wijmo event name.

repeatButtons

repeatButtons: boolean

Gets or sets a value that determines whether the calendar buttons should act as repeat buttons, firing repeatedly as the button remains pressed.

The default value for this property is true.

rightToLeft

rightToLeft: boolean

Gets a value indicating whether the control is hosted in an element with right-to-left layout.

selectionMode

selectionMode: DateSelectionMode

Gets or sets a value that determines whether users should be able to select days, day ranges, months, or no values at all.

The default value for this property is DateSelectionMode.Day.

showHeader

showHeader: boolean

Gets or sets a value that determines whether the control should display a header area with the current month and navigation buttons.

The default value for this property is true.

showMonthPicker

showMonthPicker: boolean | ShowMonthPicker

Gets or sets a value that determines whether the calendar should display a list of months when the user clicks the header element on the month calendar, and buttons for navigating to the next or previous months.

The default value for this property is ShowMonthPicker.FirstMonth.

showYearPicker

showYearPicker: boolean

Gets or sets a value that determines whether the calendar should display a list of years when the user clicks the header element on the year calendar.

The default value for this property is true.

tabOrder

tabOrder: number

Gets or sets a value of the tabindex attribute associated with the control.

tabindex attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

Because of this, to read or change control's tabindex dynamically, you should do it using this property.

value

value: Date

Gets or sets the currently selected date.

The default value for this property is the current date.

When editing ranges, the current range is defined by the interval between the value and rangeEnd properties.

Setting the value property automatically resets the rangeEnd property to null, so the user can click the range end value on the calendar to finish a range selection.

Because setting the value property resets rangeEnd, to define a range in code you must set the value first, and then rangeEnd. For example:

// this selects a range from 'start' to 'end':
cal.value = start; // rangeEnd == null
cal.rangeEnd = end; // rangeEnd == 'end'

// **this doesn't work**
cal.rangeEnd = end; // rangeEnd == 'end'
cal.value = start; // rangeEnd == null

valueChangePC

valueChangePC: EventEmitter<any>

This event is used to implement two-way binding to the value property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the valueChange event name.

valueChangedNg

valueChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo valueChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional valueChanged Wijmo event name.

weeksAfter

weeksAfter: number

Gets or sets the number of weeks to show on the calendar after the current month.

The default value for this property is zero.

weeksBefore

weeksBefore: number

Gets or sets the number of weeks to show on the calendar before the current month.

The default value for this property is zero.

wjModelProperty

wjModelProperty: string

Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is 'value'.

Static controlTemplate

controlTemplate: string

Gets or sets the template used to instantiate Calendar controls.

Methods

applyTemplate

  • applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
  • Applies the template to a new instance of a control, and returns the root element.

    This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.

    For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

    this.applyTemplate('wj-control wj-inputnumber', templateString, {
      _tbx: 'input',
      _btnUp: 'btn-inc',
      _btnDn: 'btn-dec'
    }, 'input');

    @param classNames Names of classes to add to the control's host element. @param template An HTML string that defines the control template. @param parts A dictionary of part variables and their names. @param namePart Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Parameters

    • classNames: string
    • template: string
    • parts: Object
    • Optional namePart: string

    Returns HTMLElement

beginUpdate

  • beginUpdate(): void

containsFocus

  • containsFocus(): boolean
  • Checks whether this control contains the focused element.

    Returns boolean

created

  • created(): void
  • If you create a custom component inherited from a Wijmo component, you can override this method and perform necessary initializations that you usually do in a class constructor. This method is called in the last line of a Wijmo component constructor and allows you to not declare your custom component's constructor at all, thus preventing you from a necessity to maintain constructor parameters and keep them in synch with Wijmo component's constructor parameters.

    Returns void

deferUpdate

  • deferUpdate(fn: Function): void
  • Executes a function within a beginUpdate/endUpdate block.

    The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

    Parameters

    • fn: Function

      Function to be executed.

    Returns void

endUpdate

  • endUpdate(shouldInvalidate?: boolean): void
  • Resumes notifications suspended by calls to beginUpdate.

    Parameters

    • Optional shouldInvalidate: boolean

      should invalidate the control. Default value for this parameter is true.

    Returns void

ensureVisible

  • ensureVisible(date: Date): void
  • Adjusts the {@see displayMonth} value as needed to ensure a given date is visible on the calendar.

    Parameters

    • date: Date

      Date to display.

    Returns void

focus

  • focus(): void
  • Sets the focus to this control.

    Returns void

getTemplate

  • getTemplate(): string
  • Gets the HTML template used to create instances of the control.

    This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).

    Returns string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

hitTest

  • hitTest(e: MouseEvent | Element): Date
  • Gets the date at a given mouse position or represented by a given HTML element.

    Parameters

    • e: MouseEvent | Element

      Element to test.

    Returns Date

    The date represented by the element, or null if the element does not represent a date.

initialize

  • initialize(options: any): void
  • Initializes the control by copying the properties from a given object.

    This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

    For example:

    grid.initialize({
      itemsSource: myList,
      autoGenerateColumns: false,
      columns: [
        { binding: 'id', header: 'Code', width: 130 },
        { binding: 'name', header: 'Name', width: 60 }
      ]
    });
    
    // is equivalent to
    grid.itemsSource = myList;
    grid.autoGenerateColumns = false;
    // etc.

    The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

    Parameters

    • options: any

      Object that contains the initialization data.

    Returns void

invalidate

  • invalidate(fullUpdate?: boolean): void
  • Invalidates the control causing an asynchronous refresh.

    Parameters

    • Optional fullUpdate: boolean

      Whether to update the control layout as well as the content.

    Returns void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

onDisplayMonthChanged

onFormatItem

onGotFocus

onInvalidInput

onLostFocus

onRangeChanged

onRangeEndChanged

onRefreshed

onRefreshing

onValueChanged

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

removeEventListener

  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
  • Removes one or more event listeners attached to elements owned by this Control.

    Parameters

    • Optional target: EventTarget

      Target element for the event. If null, removes listeners attached to all targets.

    • Optional type: string

      String that specifies the event. If null, removes listeners attached to all events.

    • Optional fn: any

      Handler to remove. If null, removes all handlers.

    • Optional capture: boolean

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Returns number

    The number of listeners removed.

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object
  • Returns the primitive value of the specified object.

    Returns Object

Static disposeAll

  • disposeAll(e?: HTMLElement): void
  • Disposes of all Wijmo controls contained in an HTML element.

    Parameters

    • Optional e: HTMLElement

      Container element.

    Returns void

Static getControl

  • getControl(element: any): Control
  • Gets the control that is hosted in a given DOM element.

    Parameters

    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Returns Control

Static invalidateAll

  • invalidateAll(e?: HTMLElement): void
  • Invalidates all Wijmo controls contained in an HTML element.

    Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

    If this happens, you must handle the appropriate event in the dynamic container and call the Control.invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters

    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Static refreshAll

  • refreshAll(e?: HTMLElement): void
  • Refreshes all Wijmo controls contained in an HTML element.

    This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

    Parameters

    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Events

displayMonthChanged

displayMonthChanged: Event<Calendar, EventArgs>

Occurs after the displayMonth property changes.

formatItem

Occurs when an element representing a day in the calendar has been created.

This event can be used to format calendar items for display. It is similar in purpose to the itemFormatter property, but has the advantage of allowing multiple independent handlers.

For example, the code below uses the formatItem event to disable weekends so they appear dimmed in the calendar:

// disable Sundays and Saturdays
calendar.formatItem.addHandler((s, e) => {
    let day = e.data.getDay();
    if (day == 0 || day == 6) {
      addClass(e.item, 'wj-state-disabled');
    }
});

gotFocus

gotFocus: Event<Control, EventArgs>

Occurs when the control gets the focus.

invalidInput

invalidInput: Event<Control, CancelEventArgs>

Occurs when invalid input is detected.

Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.

If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.

If the event is not canceled, the control will ignore the invalid input and will retain the original content.

lostFocus

lostFocus: Event<Control, EventArgs>

Occurs when the control loses the focus.

rangeChanged

rangeChanged: Event<Calendar, EventArgs>

Occurs when the value of the rangeEnd property changes into a non-null value, indicating a data range has been selected.

rangeEndChanged

rangeEndChanged: Event<Calendar, EventArgs>

Occurs when the value of the rangeEnd property changes.

refreshed

refreshed: Event<Control, EventArgs>

Occurs after the control has refreshed its contents.

refreshing

refreshing: Event<Control, EventArgs>

Occurs when the control is about to refresh its contents.

valueChanged

valueChanged: Event<Calendar, EventArgs>

Occurs when the value of the value property changes.