WaveMaker - Widgets API Documentation
  1. Classes
  2. Datetime

File

projects/components/widgets/input/epoch/date-time/src/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
Type : boolean
Default value : false

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

datavalue
Type : string

This property defines the value of the datetime widget.

Bindable: true
datepattern
Type : string
Default value : 'yyyy-MM-dd hh:mm:ss a'

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.

disabled
Type : boolean
Default value : false

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

Bindable: true
excludedates
Type : string

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

Bindable: true
excludedays
Type : string

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.

hint
Type : string

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

Bindable: true
hourstep
Type : number
Default value : 1

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

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

Bindable: true
mindate
Type : string

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

Bindable: true
minutestep
Type : number
Default value : 15

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

Name of the datetime widget.
outputformat
Type : string
Default value : 'timestamp'

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.

placeholder
Type : string
Default value : 'Select Date Time'

Placeholder for the datetime field.

Bindable: true
readonly
Type : boolean
Default value : false

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

Bindable: true
required
Type : boolean
Default value : false

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
shortcutkey
Type : string

The shortcut key property specifies a shortcut key to activate/focus an element. This is not available in mobile.
show
Type : boolean
Default value : true

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

Bindable: true
showbuttonbar
Type : boolean
Default value : true

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

Bindable: true
showweeks
Type : boolean
Default value : false

This property, when set, displays week number in datetime-picker UI. This is not available in mobile.
tabindex
Type : number
Default value : 0

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

results matching ""

    No results matching ""