The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

DateTimeGroupInterval Type

Lists values that specify the group interval for date-time values.

Declaration

export type DateTimeGroupInterval = 'Year' | 'Quarter' | 'Month' | 'Day' | 'Hour' | 'Minute' | 'Second' | 'DayOfYear' | 'DayOfWeek' | 'WeekOfYear' | 'WeekOfMonth' | 'MonthYear' | 'QuarterYear' | 'DayMonthYear' | 'DateHour' | 'DateHourMinute' | 'DateHourMinuteSecond' | 'None'

Members

Name Description
"Year"

Values are grouped by the year. Example: 2015, 2016, 2017

"Quarter"

Values are grouped by the quarter. Example: Q1, Q2, Q3, Q4

"Month"

Values are grouped by the month. Example: January, February, March, ... December

"Day"

Values are grouped by the day of the month. Example: 1, 2, 3, ... 31

"Hour"

Values are grouped by the hour. Example: 0, 1, 2, ... 23

"Minute"

Values are grouped by the minute. Example: 0, 1, 2, ... 59

"Second"

Values are grouped by the second. Example: 0, 1, 2, ... 59'

"DayOfYear"

Values are grouped by the day of the year. Example: 1, 2, 3, ... 365 (366 in a leap year)

"DayOfWeek"

Values are grouped by the day of the week. Example: Sunday, Monday, Tuesday, ... Saturday

"WeekOfYear"

Values are grouped by the week of the year. Example: 1, 2, 3, ... 52

"WeekOfMonth"

Values are grouped by the week of the month. Example: 1, 2, 3, 4, 5

"MonthYear"

Values are grouped by the year and month. Example: January 2012, February 2012, ... December 2012, January 2013, ...

"QuarterYear"

Values are grouped by the year and quarter. Example: Q3 2012, Q4 2012, Q1 2013, Q2 2013, ...

"DayMonthYear"

Values are grouped by the date part. Example: 3/4/2012, 3/5/2012, 3/6/2012, ...

"DateHour"

Values are grouped by the date part with the hour value. Example: 3/4/2012 0:00, 3/4/2012 1:00, 3/4/2012 2:00, ...

"DateHourMinute"

Values are grouped by the date part with the hour and minute values. Example: 3/4/2012 0:00, 3/4/2012 0:01, 3/4/2012 0:02, ...

"DateHourMinuteSecond"

Values are grouped by the date part with the hour, minute and second values. Example: 3/4/2012 0:00:00, 3/4/2012 0:00:01, 3/4/2012 0:00:02, ...

"None"

Each value is displayed "as is".

Remarks

Values listed in this type alias are used to set the Dimension.dateTimeGroupInterval property.