File

projects/components/src/widgets/common/date-time/date-time.component.doc.ts

Description

The wmDateTime component defines the datetime widget.

Index

Methods
Inputs

Methods

onBlur
onBlur($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget loses focus.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

Returns : void
onChange
onChange($event: MouseEvent, widget: any, newVal: string, oldVal: string)

Callback function which will be triggered when the widget value changes.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

newVal string No

New value of the widget

oldVal string No

Old value of the widget

Returns : void
onClick
onClick($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget is clicked. This is not available in mobile.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

Returns : void
onFocus
onFocus($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget gets focused.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

Returns : void
onMouseenter
onMouseenter($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse enters the widget. This is not available in mobile.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

Returns : void
onMouseleave
onMouseleave($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse leaves the widget. This is not available in mobile.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

Returns : void
onTap
onTap($event: TouchEvent, widget: any)

Callback function which will be triggered when the tap event is triggered on a widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered

widget any No

Instance of the datetime widget

Returns : void

Inputs

autofocus

This property makes the widget get focused automatically when the page loads.

Type : boolean

Default value : false

datavalue

This property defines the value of the datetime widget.

Bindable: true

Type : string

datepattern

This property is used to set the display pattern of the date widget. This is not available in mobile.

Allowed Values: Standard Patterns like 'yyyy-MM-dd hh:mm:ss a', 'yyyy-MM-ddTHH:mm:ss', 'yyyy, MMM dd', etc.

Type : string

Default value : 'yyyy-MM-dd hh:mm:ss a'

disabled

This property will be used to disable/enable the datetime widget on the web page.

Bindable: true

Type : boolean

Default value : false

excludedates

This property specifies the dates which are to be excluded. This is not available in mobile.

Bindable: true

Type : string

excludedays

This property specifies the days which are to be excluded. This is not available in mobile.

Allowed Values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

Type : string

hint

Hint text is shown for the datetime widget on hover. This is not available in mobile.

Bindable: true

Type : string

hourstep

This property is used to decide number of hours to increase or decrease. This is not available in mobile.

Type : number

Default value : 1

maxdate

This property is used to specify the maximum date to end with.

Bindable: true

Type : string

mindate

This property is used to specify the minimum date to start with.

Bindable: true

Type : string

minutestep

This property is used to decide number of minutes to increase or decrease. This is not available in mobile.

Type : number

Default value : 15

name

Name of the datetime widget.

Type : string

outputformat

This property output format of the datetime widget.

Allowed Values: Standard Patterns like 'yyyy-MM-dd hh:mm:ss a', 'yyyy-MM-ddTHH:mm:ss', 'yyyy, MMM dd', etc.

Type : string

Default value : 'timestamp'

placeholder

Placeholder for the datetime field.

Bindable: true

Type : string

Default value : 'Select Date Time'

readonly

This property will be used to make the datetime widget non-editable on the web page.

Bindable: true

Type : boolean

Default value : false

required

If the required property is set to true, required class is applied to the label[an asterik will be displayed next to the content of the label'].

Bindable: true

Type : boolean

Default value : false

shortcutkey

The shortcut key property specifies a shortcut key to activate/focus an element. This is not available in mobile.

Type : string

show

This property will be used to show/hide the datetime widget on the web page.

Bindable: true

Type : boolean

Default value : true

showbuttonbar

This property, when set, displays button bar in datetime-picker UI.

Bindable: true

Type : boolean

Default value : true

showweeks

This property, when set, displays week number in datetime-picker UI. This is not available in mobile.

Type : boolean

Default value : false

tabindex

This property specifies the tab order of the datetime Widget. This is not available in mobile.

Type : number

Default value : 0

result-matching ""

    No results matching ""