DateElementProperties

import type { DateElementProperties } from "https://googleapis.deno.dev/v1/docs:v1.ts";

Properties of a DateElement.

interface DateElementProperties {

dateFormat?:

| "DATE_FORMAT_UNSPECIFIED"

| "DATE_FORMAT_CUSTOM"

| "DATE_FORMAT_MONTH_DAY_ABBREVIATED"

| "DATE_FORMAT_MONTH_DAY_FULL"

| "DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED"

| "DATE_FORMAT_ISO8601";

displayText?: string;

locale?: string;

timeFormat?:

| "TIME_FORMAT_UNSPECIFIED"

| "TIME_FORMAT_DISABLED"

| "TIME_FORMAT_HOUR_MINUTE"

| "TIME_FORMAT_HOUR_MINUTE_TIMEZONE";

timestamp?: Date;

timeZoneId?: string;

}

§Properties

[src]

Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as MMM d, y in en_US, or locale specific equivalent.

displayText?: string

[src]

Output only. Indicates how the DateElement is displayed in the document.

locale?: string

[src]

The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, en_US. If unset, the default locale is en_US.

timeFormat?: "TIME_FORMAT_UNSPECIFIED" | "TIME_FORMAT_DISABLED" | "TIME_FORMAT_HOUR_MINUTE" | "TIME_FORMAT_HOUR_MINUTE_TIMEZONE"

[src]

Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.

timestamp?: Date

[src]

The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of 18000 with a date format of DATE_FORMAT_ISO8601 and time format of TIME_FORMAT_HOUR_MINUTE would be displayed as 1970-01-01 5:00 AM. A timestamp of 18000 with date format of DATE_FORMAT_8SO8601, time format of TIME_FORMAT_HOUR_MINUTE, and time zone set to America/New_York will instead be 1970-01-01 12:00 AM.

timeZoneId?: string

[src]

The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, America/New York. If unset, the default time zone is etc/UTC.