WorkTimeRule Class

A work time rule which is used to exclude non-working time from the date-time X-axis.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

NuGet Packages: DevExpress.Charts, DevExpress.WindowsDesktop.Charts

Declaration

C#

public class WorkTimeRule :
    ChartElement,
    IWorkTimeRule,
    IXtraSupportDeserializeCollectionItem

VB.NET

Public Class WorkTimeRule
    Inherits ChartElement
    Implements IWorkTimeRule,
               IXtraSupportDeserializeCollectionItem

Related API Members

The following members return WorkTimeRule objects:

• WorkTimeRuleCollection.Item[Int32]

Example

The following code demonstrates how to configure work time rules.

C#

XYDiagram chartDiagram = (XYDiagram)financialChart.Diagram;
DateTimeScaleOptions xAxisScaleOptions = chartDiagram.AxisX.DateTimeScaleOptions;

// This property turns on axis values filtering by rules.
xAxisScaleOptions.WorkTimeOnly = true;

// Create a new instance of the worktime rule which will be used to specify
// the worktime displayed on the X-axis.
WorkTimeRule weekdayRule = new WorkTimeRule();
xAxisScaleOptions.WorkTimeRules.Add(weekdayRule);
// Specify one or more work intervals of this rule.
weekdayRule.WorkIntervals.Add(new TimeInterval(09, 00, 00, 19, 00, 00));
// Add weekdays on which this rule should be applied.
weekdayRule.Weekdays = Weekday.Monday | Weekday.Tuesday | Weekday.Wednesday 
        | Weekday.Thursday | Weekday.Friday;

WorkTimeRule dateRule = new WorkTimeRule();
xAxisScaleOptions.WorkTimeRules.Add(dateRule);
dateRule.WorkIntervals.Add(new TimeInterval(12, 00, 00, 16, 00, 00));
// Besides Weekdays, you can specify the Date 
// on which this rule should be applied.
dateRule.Date = new DateTime(2017, 1, 1);

VB.NET

Dim chartDiagram As XYDiagram = DirectCast(financialChart.Diagram, XYDiagram)
Dim xAxisScaleOptions As DateTimeScaleOptions = chartDiagram.AxisX.DateTimeScaleOptions

' This property turns on axis values filtering by rules.
xAxisScaleOptions.WorkTimeOnly = True

' Create a new instance of the worktime rule which will be used to specify 
' the worktime displayed on the X-axis.
Dim weekdayRule As New WorkTimeRule()
xAxisScaleOptions.WorkTimeRules.Add(weekdayRule)
' Specify one or more work intervals of this rule.
weekdayRule.WorkIntervals.Add(New TimeInterval(09, 00, 00, 19, 00, 00))
' Add weekdays on which this rule should be applied.
weekdayRule.Weekdays = Weekday.Monday Or Weekday.Tuesday Or Weekday.Wednesday _
        Or Weekday.Thursday Or Weekday.Friday

Dim dateRule As New WorkTimeRule()
xAxisScaleOptions.WorkTimeRules.Add(dateRule)
dateRule.WorkIntervals.Add(New TimeInterval(12, 00, 00, 16, 00, 00))
' Besides Weekdays, you can specify the Date 
' on which this rule should be applied.
dateRule.Date = New DateTime(2017, 1, 1)

Implements

IXtraSupportDeserializeCollectionItem

Inheritance

Object

ChartElement

WorkTimeRule