Google is committed to advancing racial equity for Black communities. See how.

Class DatePicker

DatePicker

An input field that allows inputing a date.

var dateTimePicker = CardService.newDatePicker()
    .setTitle("Enter the date.")
    .setFieldName("date_field")
    // Set default value as Jan 1, 2018 UTC. Either a number or string is acceptable.
    .setValueInMsSinceEpoch(1514775600)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleDateTimeChange"));

Methods

MethodReturn typeBrief description
setFieldName(fieldName)DatePickerSets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
setOnChangeAction(action)DatePickerSets an Action that the script performs whenever the picker input changes.
setTitle(title)DatePickerSets the title displayed above the input field.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerSets the prefilled value to be set in the input field.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerSets the prefilled value to be set in the input field.

Detailed documentation

setFieldName(fieldName)

Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. The field name is visible to the user. Required; the specified field name must be unique.

Parameters

NameTypeDescription
fieldNameStringThe name to assign to this input.

Return

DatePicker — This picker, for chaining.


setOnChangeAction(action)

Sets an Action that the script performs whenever the picker input changes.

Parameters

NameTypeDescription
actionActionThe action to take.

Return

DatePicker — This picker, for chaining.


setTitle(title)

Sets the title displayed above the input field.

Parameters

NameTypeDescription
titleStringThe input field title.

Return

DatePicker — This picker, for chaining.


setValueInMsSinceEpoch(valueMsEpoch)

Sets the prefilled value to be set in the input field.

Parameters

NameTypeDescription
valueMsEpochNumberThe default value placed in the input as a number, in milliseconds since the epoch. Only the date of the epoch time is used, and the time of the epoch time is discarded. It is always represented as a string in the form callback parameters.

Return

DatePicker — This picker, for chaining.


setValueInMsSinceEpoch(valueMsEpoch)

Sets the prefilled value to be set in the input field.

Parameters

NameTypeDescription
valueMsEpochStringThe default value placed in the input as a string, in milliseconds since the epoch. Only the date of the epoch time is used, and the time of the epoch time is discarded. It is always represented as a string in the form callback parameters.

Return

DatePicker — This picker, for chaining.