AxisBase

Initializes a new instance of the AxisBase class.

Gets or sets the animated VisibleRange of the Axis. When this property is set, the axis animates the VisibleRange to the new value over a duration of 500ms

Gets or sets whether to auto-align the visible range to the data when it is set. Note that this property only applies to the X-Axis. The default value is False. Whenever the VisibleRange is set on the X-Axis, the Min and Max values will be aligned to data values in the XValues

Gets or sets AutoRange Mode

Gets or sets value, that indicates whether calculate ticks automatically. Default is True.

Gets or sets the AxisAlignment for this Axis. Default is Right.

Gets or sets the Fill of the Axis Bands. Also see DrawMajorBands to enable this behaviour

Gets or sets the AxisMode, e.g. Linear or Logarithmic, that this Axis operates in

Gets or sets the Axis Title

Gets the current data-point size in pixels

Gets or sets the Text Formatting String for Labels on this cursor

Gets the DataRange (full extents of the data) of the Axis.

Gets the default ILabelProvider instance.

If True, draw labels for each major tick on the Axis, else skips this step

If True, draws Major Axis Bands (a filled area between major gridlines), else skips this step

If True, draws Major Grid Lines, else skips this step

If True, draws Major Tick Lines, else skips this step

If True, draws Minor Grid Lines, else skips this step

If True, draws Minor Tick Lines, else skips this step

Gets or sets a flag indicating whether to flip the tick and pixel coordinate generation for this axis, causing the axis ticks to decrement and chart to be flipped in the axis direction

Get the GridLinesPanel instance off the parent UltrachartSurface

Gets or sets the GrowBy Factor. e.g. GrowBy(0.1, 0.2) will increase the axis extents by 10% (min) and 20% (max) outside of the data range

Gets whether the VisibleRange has default value

Gets whether the VisibleRange is valid, e.g. is not null, is not NaN and the difference between Max and Min is not zero

Gets or sets the string Id of this axis. Used to associated IRenderableSeries and YAxisDragModifier

Gets whether the current axis is flipped (e.g. YAxis on the bottom or top, or XAxis on the left or right)

Gets a value indicating whether this instance is a category axis.

Gets or sets whether current Axis should placed in the center of chart or not

Gets whether the current axis is horizontal or not

Gets or sets a value indicating whether Label Culling is enabled (when labels overlap) on this AxisPanel instance

Gets a value indicating whether this instance is a logarithmic axis.

Gets a value indicating whether this instance is a polar axis.

Gets or sets whether current Axis is the main one in axis collection

Gets or sets whether current Axis is a static axis

Gets a value indicating whether updates for the target are currently suspended

Gets whether the current axis is an X-Axis or not

Gets or sets a ILabelProvider instance, which may be used to programmatically override the formatting of text and cursor labels. For examples, see the DefaultLabelProvider and TradeChartAxisLabelProvider

Gets or sets the Major Delta

Gets or sets the Major Grid Line Style (TargetType Line), applied to all major gridlines drawn by this axis

Gets or sets the Major Line Stroke for this axis

Gets or sets the Major Tick Line Style (TargetType Line), applied to all major ticks on this axis

Gets or sets the max ticks.

Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange

Gets or sets the Minor Delta

Gets or sets the Minor Grid Line Style (TargetType Line), applied to all minor gridlines drawn by this axis

Gets or sets the Minoe Line Stroke for this axis

Gets or sets the number of Minor Delta ticks per Major Tick

Gets or sets the Minor Tick Line Style (TargetType Line), applied to all major ticks on this axis

Gets the ModifierAxisCanvas, which may be used to overlay markers on the canvas

Gets or sets the Axis Orientation, e.g. Horizontal (XAxis) or Vertical (YAxis)

Gets or sets the ParentSurface that this Axis is associated with

Get the RenderSurface instance off the parent UltrachartSurface

Gets or Sets Axis ScrollBar

Gets the ServiceContainer which provides access to services throughout Ultrachart. ServiceContainers are created one per UltrachartSurface instance, and shared between peripheral components such as AxisBase, BaseRenderableSeries, ChartModifierBase instances. For a full list of available services, see the remarks on ServiceContainer

Gets whether the current axis is an X-Axis or not

Gets or sets the suggested height of the element.

Rückgabe: The height of the element, in device-independent units (1/96th inch per unit). The default value is NaN. This value must be equal to or greater than 0.0. See Remarks for upper bound information.

Gets or sets the width of the element.

Rückgabe: The width of the element, in device-independent units (1/96th inch per unit). The default value is NaN. This value must be equal to or greater than 0.0. See Remarks for upper bound information.

Gets or sets the stroke thickness.

Gets or sets the Text Formatting String for Tick Labels on this axis

Gets or sets a ITickCoordinatesProvider instance on current axis, which is used to transform the data-values received from the TickProvider instance to the coordinates for Axis Gridlines, Ticks and Labels drawing.

Gets or sets a style for the labels on this Axis.

Gets or sets a ITickProvider instance on current axis, which is used to compute the data-values of Axis Gridlines, Ticks and Labels.

Gets or sets the tick text brush applied to text labels

Gets or sets the Axis Title Font Size

Gets or sets the Axis Title Font Weight

Gets or sets the Style of the Axis Title

Gets or sets the VisibleRange of the Axis.

Gets or sets the VisibleRangeLimit of the Axis. This will be used to clip the axis during ZoomExtents and AutoRange operations

Gets or setts the VisibleRangeLimitMode of the Axis. This property defines which parts of VisibleRangeLimit will be used by axis

Animates the visible range of the axis to the destination VisibleRange, over the specified Duration. Also see AnimatedVisibleRange property which has a default duration of 500ms

to

The end range

duration

The duration of the animation.

Asserts the type passed in is supported by the current axis implementation

dataType

Asserts the IRange is of the correct type for this axis

range

The range to assert

Calculates data range of current axis

Calcuates the delta's for use in this render pass

Overridden by derived types, called internal to calculate MinorTicks, MajorTicks before Axis drawing

Gets the aligned VisibleRange of the axis, with optional ZoomToFit flag. If ZoomToFit is true, it will return the DataRange plus any GrowBy applied to the axis

renderPassInfo

Struct containing data for the current render pass

Rückgabe: The VisibleRange of the axis

Clears axis labels, ticks off this axis

Clones this instance.

When overridden in derived classes, changes value of the VisibleRange according to axis requirements before it is applied

Coerce if current range is zero range

maximumRange

Current maximum range

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

Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called

Draws a single grid line on the RenderSurface, using the specified Style (TargetType Line), XyDirection and integer coordinate.

renderContext

The IRenderContext2D instance to draw to

linePen

The pen (TargetType IPen2D) to apply to the grid line

direction

The X or Y direction to draw the

atPoint

The integer coordinate to draw at. If direction is XDirection, the coodinate is an X-coordinate, else it is a Y-coordinate

Called internal to draw gridlines before Axis drawing

Draws the ticks and gridlines during a render pass

canvas

The canvas to draw labels on.

tickCoords

The tick coords containing all coordinates for ticks and gridlines.

offset

String formats text for the cursor, using the CursorTextFormatting property as a formatting string

value

The data value to format

hitTest

Cursor hit test.

Rückgabe: The string formatted data value

String formats the text, using the TextFormatting property as a formatting string

value

The data value to format

format

A composite format string

Rückgabe: The string formatted data value

String formats the text, using the TextFormatting property as a formatting string

value

The data value to format

Rückgabe: The string formatted data value

Returns the offset of the axis relative to the RenderSurface. Is used for cases where axes are vertically or horizontally stacked.

Gets an AxisParams struct with info about the current axis setup

Gets the bounds of the current HitTestable element relative to another HitTestable element

relativeTo

The relative to.

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

Gets the current ICoordinateCalculator for this Axis, based on current Visible Range and axis type

Returns the current IAxisInteractivityHelper, valid for the current render pass, which may be used to interact with the axis (Scroll, Zoom, Pan).

Transforms a pixel coordinate into a data value for this axis.

pixelCoordinate

Returns an default non zero IRange, called internally by Ultrachart to reset the VisibleRange of an axis to an undefined state

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

Returns major tick index e.g value 0 has index #0, 0 + MajorDelta - #1, 0 + 2*MajorDelta - #2 etc...

tick

Calculates max auto ticks amount, which is >= 1

Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied

Returns an offset for the axis

Gets the integer indices of the X-Data array that are currently in range.

Rückgabe: The indices to the X-Data that are currently in range

Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method

Returns a list of types which current axis is designed to work with

Returns an undefined IRange, called internally by Ultrachart to reset the VisibleRange of an axis to an undefined state

Returns the max range only for that axis (by the data-series on it), based on "windowed" = "displayed in current viewport" uses GrowBy()

xRanges

Calculates the max range based on corresponding x ranges

Performs a hit test on the Axis, returning the Data Value at the specific x or y pixel coordinate. This operation is the opposite of IComparable)

atPoint

The pixel coordinate on this Axis corresponding to the input DataValue

Rückgabe: An AxisInfo struct containing the datavalue and formatted data value at this coordinate

Performs a HitTest operation on the AxisBase. The supplied is used to convert to AxisInfo struct, which contains information about the axis, as well as formatted values

dataValue

The data value.

Rückgabe: The AxisInfo result

Asynchronously requests that the element redraws itself plus children. Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call)

Provides a DependencyProperty callback which invalidates the parent UltrachartSurface

d

e

Checks whether is not Null and is of valid type for this axis

range

Returns true if the Point is within the bounds of the current HitTestable element

point

The point to test

Rückgabe: true if the Point is within the bounds

Checks whether is valid visible range for this axis

range

Checks if the VisibleRange is valid, e.g. is not null, is not NaN, the difference between Max and Min is positive

When overridden in a derived class, is invoked whenever application code or internal processes call OnApplyTemplate.

Called internally immediately before a render pass begins

Called when the instance is drawn

renderContext

The IRenderContext2D used for drawing

renderPassData

Contains arguments and parameters for this render pass

Called when the axis should redraw itself.

tickCoords

Raises the PropertyChanged event, as part of INotifyPropertyChanged implementation

propertyName

Name of the property.

Raises the VisibleRangeChanged event

args

The VisibleRangeChangedEventArgs containing event data

Generates AxisBase from its XML representation.

reader

Resumes updates on the target, intended to be called by IUpdateSuspender

Scrolls current VisibleRange by the specified number of pixels with the specified animation duration

pixelsToScroll

Scroll N pixels from the current visible range

clipMode

Defines how scrolling behaves when you reach the edge of the Axis extents. e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside

duration

The duration of animation when zooming to extents

Scrolls current VisibleRange by the specified number of pixels

pixelsToScroll

Scroll N pixels from the current visible range

clipMode

Defines how scrolling behaves when you reach the edge of the Axis extents. e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside

Translates current VisibleRange by the specified number of datapoints with the specified animation duration

pointAmount

Amount of points that the start visible range is scrolled by

duration

The duration of animation when zooming to extents

Translates current VisibleRange by the specified number of datapoints

pointAmount

Amount of data points that the start visible range is scrolled by

From the starting IRange, scrolls to a new range by the specified number of pixels

startVisibleRange

The start visible range

pixelsToScroll

Scroll N pixels from the start visible range

From the starting IRange, scrolls to a new range by the specified number of pixels, with the specified range limit

startVisibleRange

The start visible range

pixelsToScroll

Scroll N pixels from the start visible range

rangeLimit

The range limit.

Sets the cursor for this Axis

cursor

The Cursor instance

Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued

Rückgabe: The disposable Update Suspender

Translates the point relative to the other hittestable element

point

The point.

relativeTo

The relative to.

When current VisibleRange is invalid, tries to replace it by , if both ranges are invalid, throws an exception

newRange

The range to apply

oldRange

The previous VisibleRange

Rückgabe: The value, which indicates whether the VisibleRange is applied or no

Called to check if the axis properties are valid for rendering. Will throw an exception if not

Throws appropriate exceptions if the VisibleRange has a wrong type, or VisibleRange.Min > VisibleRange.Max

Converts AxisBase into its XML representation.

writer

Performs zoom on current IAxis, using as a coordinate of new range start and as a coordinate of new range end

fromCoord

The coordinate of new range start in pixels

toCoord

The coordinate of new range end in pixels

duration

The duration of animation when zooming to extents

Performs zoom on current IAxis, using as a coordinate of new range start and as a coordinate of new range end

fromCoord

The coordinate of new range start in pixels

toCoord

The coordinate of new range end in pixels

Performs zoom on current IAxis, using as a multiplier of range start and as a multiplier of range end

minFraction

The multiplier of range start

maxFraction

The multiplier of range end

duration

The duration of animation when zooming to extents

Performs zoom on current IAxis, using as a multiplier of range start and as a multiplier of range end

minFraction

The multiplier of range start

maxFraction

The multiplier of range end

Raised when data range is changed

Raised when properties are changed

Raised when the VisibleRange is changed

Defines the Animated VisibleRange DependencyProperty

Defines the AutoAlignVisibleRange DependencyProperty

Defines the AutoRange DependencyProperty

Defines the AutoTicks DependencyProperty

Defines the AxisAlignment DependencyProperty

Defines the AxisBandsFill DependencyProperty

Defines the AxisMode DependencyProperty

Defines the AxisTitle DependencyProperty

Defines the CursorTextFormatting DependencyProperty

The Default Axis Id for new Axes

Defines the DefaultFormatter DependencyProperty

Defines the DrawLabels DependencyProperty

Defines the DrawMajorBands DependencyProperty

Defines the DrawMajorGridLines DependencyProperty

Defines the DrawMajorTicks DependencyProperty

Defines the DrawMinorGridLines DependencyProperty

Defines the DrawMinorTicks DependencyProperty

Defines the FlipCoordinates DependencyProperty

Defines the GrowBy DependencyProperty

Defines the Id DependencyProperty

Defines the IsCenterAxis DependencyProperty

The IsLabelCullingEnabled DependencyProperty

Defines the IsPrimaryAxis DependencyProperty

Defines the IsStaticAxis DependencyProperty

Defines the LabelFormatter DependencyProperty

Defines the MajorDelta DependencyProperty

Defines the MajorGridLineStyle DependencyProperty

Defines the MajorTickLineStyle DependencyProperty

Defines the MaxAutoTicks DependencyProperty

Defines the minimum distance to the edge of the chart to cull axis labels

Defines the MinimalZoomConstrain DependencyProperty

Defines the MinorDelta DependencyProperty

Defines the MinorGridLineStyle DependencyProperty

Defines the MinorDelta DependencyProperty

Defines the MinorTickLineStyle DependencyProperty

Defines the Orientation DependencyProperty

Defines the Axis ScrollBar

Defines the StrokeThickness DependencyProperty

Defines the TextFormatting DependencyProperty

Defines the TickCoordinatesProvider DependencyProperty

Defines the AutoTicks DependencyProperty

Defines the TickProvider DependencyProperty

Defines the TickTextBrush DependencyProperty

Defines the TitleFontWeight DependencyProperty

Defines the TitleFontWeight DependencyProperty

Defines the TitleStyle DependencyProperty

Defines the VisibleRangeLimitMode DependencyProperty

Defines the VisibleRangeLimit DependencyProperty

Defines the VisibleRangePoint DependencyProperty

Defines the VisibleRange DependencyProperty

Gets GrowBy Min and Max which applied to VisibleRange if VisibleRange.Min == VisibleRAnge.Max

The current CoordinateCalculator for this render pass

The current InteractivityHelper for this render pass