Class ChartDateTimeInterval

Represents a DateTime interval value.

Inheritance

System.Object

ChartDateTimeInterval

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Base.dll

Syntax

public class ChartDateTimeInterval

Fields

DefaultIntervalName

Name of default interval.

Declaration

public const string DefaultIntervalName = "default"

Field Value

Type	Description
System.String

See Also

ChartIntervalCollection

Intervals

Properties

Offset

Gets or sets the value of the offset. Intervals can have offsets. Offsets merely affect the first position when an interval is applied to a range. They translate the first position by the value of the offset.

Declaration

public double Offset { get; set; }

Property Value

Type	Description
System.Double

OffsetType

Gets or sets the type of the offset. Intervals can have offsets. Offsets merely affect the first position when an interval is applied to a range. They translate the first position by the value of the offset.

Declaration

public ChartDateTimeIntervalType OffsetType { get; set; }

Property Value

Type	Description
ChartDateTimeIntervalType

Parent

The ChartDateTimeRange object with which this interval is associated. Intervals are not created stand alone but in the context of a range.

Declaration

public ChartDateTimeRange Parent { get; }

Property Value

Type	Description
ChartDateTimeRange

Type

Gets or sets the type of this interval.

Declaration

public ChartDateTimeIntervalType Type { get; set; }

Property Value

Type	Description
ChartDateTimeIntervalType

Value

Gets or sets the value of this interval. Interval values should be interpreted in the context of Type.

Declaration

public double Value { get; set; }

Property Value

Type	Description
System.Double

Methods

GetIntervalCount(IEnumerable)

Given a ChartDateTimeInterval.Enumerator instance, this method simply loops through and calculates the number of distinct positions in the range that the iterator represents. ChartDateTimeRange

Declaration

public static int GetIntervalCount(IEnumerable enumerable)

Parameters

Type	Name	Description
System.Collections.IEnumerable	enumerable	An instance of the ChartDateTimeInterval.Enumerator.

Returns

Type	Description
System.Int32	Number of distinct positions.

Iterator()

Overloaded. Creates and returns a default iterator that will iterate over the associated range (Parent.

Declaration

public IEnumerable Iterator()

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(ChartDateTimeInterval.IterationFilter)

Creates and returns an iterator that will iterate over the associated range (Parent. The IterationFilter callback will be called for each position in this range to check if the position should be included.

Declaration

public IEnumerable Iterator(ChartDateTimeInterval.IterationFilter filter)

Parameters

Type	Name	Description
ChartDateTimeInterval.IterationFilter	filter	The filter.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(ChartDateTimeInterval.IterationFilter, ChartDateTimeInterval.IterationModifier)

Creates and returns an iterator that will iterate over the associated range (Parent. The IterationModifier callback will be called for each position in this range to allow the DateTime value of each position to be modified. The IterationFilter callback will be called for each position in this range to check if the position should be included.

Declaration

public IEnumerable Iterator(ChartDateTimeInterval.IterationFilter filter, ChartDateTimeInterval.IterationModifier modifier)

Parameters

Type	Name	Description
ChartDateTimeInterval.IterationFilter	filter	The filter.
ChartDateTimeInterval.IterationModifier	modifier	The modifier.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(ChartDateTimeInterval.IterationModifier)

Creates and returns an iterator that will iterate over the associated range (Parent. The IterationModifier callback will be called for each position in this range to allow the DateTime value of each position to be modified.

Declaration

public IEnumerable Iterator(ChartDateTimeInterval.IterationModifier modifier)

Parameters

Type	Name	Description
ChartDateTimeInterval.IterationModifier	modifier	The modifier.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(DateTime, DateTime)

Creates and returns a default iterator that will iterate over the associated range (Parent. Only values that are between rangeStart and rangeEnd will be used.

Declaration

public IEnumerable Iterator(DateTime rangeStart, DateTime rangeEnd)

Parameters

Type	Name	Description
System.DateTime	rangeStart	The range start.
System.DateTime	rangeEnd	The range end.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(DateTime, DateTime, ChartDateTimeInterval.IterationFilter)

Creates and returns an iterator that will iterate over the associated range (Parent. Only values that are between rangeStart and rangeEnd will be used. In this range, the IterationFilter callback will be called for each position in this range to check if the position should be included.

Declaration

public IEnumerable Iterator(DateTime rangeStart, DateTime rangeEnd, ChartDateTimeInterval.IterationFilter filter)

Parameters

Type	Name	Description
System.DateTime	rangeStart	The range start.
System.DateTime	rangeEnd	The range end.
ChartDateTimeInterval.IterationFilter	filter	The filter.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(DateTime, DateTime, ChartDateTimeInterval.IterationFilter, ChartDateTimeInterval.IterationModifier)

Creates and returns an iterator that will iterate over the associated range (Parent. Only values that are between rangeStart and rangeEnd will be used. In this range, the IterationModifier callback will be called for each position in this range to allow it to be modified. For each modified value, the IterationFilter callback will be called to check if the position should be included.

Declaration

public IEnumerable Iterator(DateTime rangeStart, DateTime rangeEnd, ChartDateTimeInterval.IterationFilter filter, ChartDateTimeInterval.IterationModifier modifier)

Parameters

Type	Name	Description
System.DateTime	rangeStart	The range start.
System.DateTime	rangeEnd	The range end.
ChartDateTimeInterval.IterationFilter	filter	The filter.
ChartDateTimeInterval.IterationModifier	modifier	The modifier.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

Iterator(DateTime, DateTime, ChartDateTimeInterval.IterationModifier)

Creates and returns an iterator that will iterate over the associated range (Parent. Only values that are between rangeStart and rangeEnd will be used. In this range, the IterationModifier callback will be called for each position in this range to allow it to be modified.

Declaration

public IEnumerable Iterator(DateTime rangeStart, DateTime rangeEnd, ChartDateTimeInterval.IterationModifier modifier)

Parameters

Type	Name	Description
System.DateTime	rangeStart	The range start.
System.DateTime	rangeEnd	The range end.
ChartDateTimeInterval.IterationModifier	modifier	The modifier.

Returns

Type	Description
System.Collections.IEnumerable	Returns IEnumerable object.

ToString()

Overridden. Returns a string representation of this interval.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current System.Object.

Overrides

System.Object.ToString()