DateTimeAxis
Provides a Linear, Value DateTime Axis, capable of rendering DateTime ticks on the X-Axis of a UltrachartSurface.
Inherits: TimeSpanAxisBase
Constructors
public DateTimeAxis()
dateTimeAxis = DateTimeAxis()
Initializes a new instance of the DateTimeAxis class.
Properties
public string SubDayTextFormatting { get; set; }
value = dateTimeAxis.SubDayTextFormatting
dateTimeAxis.SubDayTextFormatting = value
Gets or sets the Text Formatting String used for Axis Tick Labels when the range of the axis is sub-day
Methods
public override void AssertDataType(Type dataType)
dateTimeAxis.AssertDataType(dataType)
Asserts the type passed in is supported by the current axis implementation
- dataType
public override IRange CalculateYRange(RenderPassInfo renderPassInfo)
result = dateTimeAxis.CalculateYRange(renderPassInfo)
Calculates the zoom-to-fit Y-Range of the axis, accounting for the data that is in the viewport and applying any GrowBy margin
- renderPassInfo
- Struct containing data for the current render pass
Returns: The VisibleRange of the axis
protected override IRange CoerceZeroRange(IRange maximumRange)
result = dateTimeAxis.CoerceZeroRange(maximumRange)
Coerce if current range is zero range
- maximumRange
- Current maximum range
protected override IComparable ConvertTickToDataValue(IComparable value)
result = dateTimeAxis.ConvertTickToDataValue(value)
When overridden in a derived class, converts a tick value to a data value. For instance, this may be overridden in the CategoryDateTimeAxis to convert between indices and DateTimes
- value
public override IRange GetDefaultNonZeroRange()
result = dateTimeAxis.GetDefaultNonZeroRange()
Returns an default non zero IRange, called internally by Ultrachart to reset the VisibleRange of an axis to an undefined state
protected override IDeltaCalculator GetDeltaCalculator()
result = dateTimeAxis.GetDeltaCalculator()
Returns an instance of an IDeltaCalculator which is used to compute the data-values of MajorDelta, MinorDelta. Overridden by derived types to allow calculations specific to that axis type.
Returns: An IDeltaCalculator instance
public override IRange GetMaximumRange()
result = dateTimeAxis.GetMaximumRange()
Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied
protected override List<Type> GetSupportedTypes()
result = dateTimeAxis.GetSupportedTypes()
Returns a list of types which current axis is designed to work with
public override IRange GetUndefinedRange()
result = dateTimeAxis.GetUndefinedRange()
Returns an undefined IRange, called internally by Ultrachart to reset the VisibleRange of an axis to an undefined state
public override bool IsOfValidType(IRange range)
result = dateTimeAxis.IsOfValidType(range)
Checks whether is not Null and is of valid type for this axis
- range
protected override IRange ToVisibleRange(IComparable min, IComparable max)
result = dateTimeAxis.ToVisibleRange(min, max)
When overriden in a derived class, converts a Min Max IComparable value into an IRange of the correct type for this axis
- min
- The min value
- max
- The max value
Returns: The IRange instance
Fields
public static readonly DependencyProperty SubDayTextFormattingProperty
value = DateTimeAxis.SubDayTextFormattingProperty
Defines the SubDayTextFormatting DependencyProperty