Dimension.DateTimeGroupInterval Property
Gets or sets the group interval for date-time values.
Namespace: DevExpress.DashboardCommon
Assembly:
DevExpress.Dashboard.v25.1.Core.dll
NuGet Package:
DevExpress.Dashboard.Core
Declaration
[DefaultValue(DateTimeGroupInterval.Year)]
public DateTimeGroupInterval DateTimeGroupInterval { get; set; }
<DefaultValue(DateTimeGroupInterval.Year)>
Public Property DateTimeGroupInterval As DateTimeGroupInterval
Property Value
Available values:
| Name |
Description |
|
Year
|
Values are grouped by the year.
Example: 2010, 2011, 2012
|
|
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
Week numbers are calculated based on the following current culture’s settings: the CalendarWeekRule and FirstDayOfWeek properties.
|
|
WeekOfMonth
|
Values are grouped by the week of the month.
Example: 1, 2, 3, 4, 5
|
|
QuarterYear
|
Values are grouped by the year and quarter.
Example: Q3 2012, Q4 2012, Q1 2013, Q2 2013, …
|
|
MonthYear
|
Values are grouped by the year and month.
Example: January 2012, February 2012, … December 2012, January 2013, …
|
|
WeekYear
|
Values are grouped by the date of the first day of the week (uses culture settings)
Example: 7/1/2018, 7/8/2018, 7/15/2018
|
|
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”.
|
Use the DateTimeGroupInterval property to specify how to group date-time values contained in this Dimension. For instance, they can be grouped by years, months, quarters, days of the week, hours, days of the year, and other date-time intervals.
Refer to the following help topic to see which intervals are supported for DateTime, DateOnly, and TimeOnly fields: Grouping Date-Time Values. If a date-time interval is not supported by the field, the dashboard control shows a notification.
If the Dimension does not contain date-time data, the DateTimeGroupInterval property is not in effect.
You can also format date-time values depending on their group interval. For this, use the DataItem.DateTimeFormat property.
For string dimensions, use the following property to set a group interval: TextGroupInterval.
Example
The following code snippet shows how to create the date-time and string dimensions with the specified group intervals.
Dimension orderDateDimension = new Dimension("Order Date", DateTimeGroupInterval.MonthYear);
Dimension categoryDimension = new Dimension("CategoryName", TextGroupInterval.Alphabetical);
Dim orderDateDimension As New Dimension("Order Date", DateTimeGroupInterval.MonthYear)
Dim categoryDimension As New Dimension("CategoryName", TextGroupInterval.Alphabetical)
See Also