CategoryDateTimeAxis
Provides a Linear, Category DateTime Axis, capable of rendering DateTime ticks on the X-Axis of a UltrachartSurface. The CategoryDateTimeAxis is specifically used in stock-charts or financial charts, since the category-nature of the axis automatically collapses weekend gaps and overnight gaps in trading charts. Each data-point is treated as equidistant despite the X Data-value.
Erbt von: AxisBase
Implementiert: ICategoryAxis, IAxis, IAxisParams, IHitTestable, ISuspendable, IInvalidatableElement, IDrawable
Konstruktoren
CategoryDateTimeAxis()
Initializes a new instance of the CategoryDateTimeAxis class.
Eigenschaften
BarTimeFrame : double
Gets or sets the Bar Time Frame in seconds. This is the number of seconds that each data-point represents on the CategoryDateTimeAxis and is required for proper rendering. A default value of -1 allows the CategoryDateTimeAxis to estimate the timeframe
CurrentDatapointPixelSize : double
Gets the current data-point width, which is the width of one data-point in pixels on the category axis
IsCategoryAxis : bool
Gets a value indicating whether this instance is category axis.
MinimalZoomConstrain : int?
Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange
SubDayTextFormatting : string
Gets or sets the Text Formatting String used for Axis Tick Labels when the range of the axis is sub-day
Methoden
CalculateDataRange() : IRange
Calculates data range of current axis
CalculateDelta()
Calcuates the delta's for use in this render pass
CalculateYRange(RenderPassInfo) : IRange
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
Rückgabe: The VisibleRange of the axis
ConvertTickToDataValue(IComparable) : IComparable
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
GetAxisParams() : AxisParams
Gets an AxisParams struct with info about the current axis setup
GetCoordinate(IComparable) : double
Given the Data Value, returns the x or y pixel coordinate at that value on the Axis. This operation is the opposite of Point)
- value
- The DataValue as input
Rückgabe: The pixel coordinate on this Axis corresponding to the input DataValue
GetDataValue(double) : IComparable
Transforms a pixel coordinate into a data value for this axis.
- pixelCoordinate
GetDefaultNonZeroRange() : IRange
Returns an default non zero IRange, called internally by Ultrachart to reset the VisibleRange of an axis to an undefined state
GetDeltaCalculator() : IDeltaCalculator
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.
Rückgabe: An IDeltaCalculator instance
GetMaximumRange() : IRange
Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied
GetSupportedTypes() : List<Type>
Returns a list of types which current axis is designed to work with
GetUndefinedRange() : IRange
Returns an undefined IRange, called internally by Ultrachart to reset the VisibleRange of an axis to an undefined state
OnBeginRenderPass(RenderPassInfo, IPointSeries)
Called at the start of a render pass, passing in the root IPointSeries which will define the categories
- renderPassInfo
- firstPointSeries
- the root IPointSeries which will define the categories
ToDateRange(IndexRange) : DateRange
Converts the CategoryDateTimeAxis's VisibleRange of type IndexRange to a DateRange of concrete date-values. Note: If either index is outside of the range of data on the axis, the date values will be inteporlated.
- visibleRange
- The input IndexRange
Rückgabe: The DateRange with transformed dates that correspond to input indices
Felder
BarTimeFrameProperty : DependencyProperty
Defines the BarTimeFrame DependencyProperty. A default value of -1 allows the CategoryDateTimeAxis to estimate the timeframe
SubDayTextFormattingProperty : DependencyProperty
Defines the SubDayTextFormatting DependencyProperty