SCIAxisCore Class Reference

Provides base class for 2D Axis types throughout the SciChart SDK. More...

#import <SCIAxisCore.h>

Inheritance diagram for SCIAxisCore:
<SCIAxisCoreProtocol> <SCIInvalidatableElementProtocol> SCIAxisBase SCINumericAxis SCITimeSpanAxisBase SCICategoryNumericAxis SCILogarithmicNumericAxis SCIDateTimeAxis SCICategoryDateTimeAxis

Instance Methods

(BOOL) - isCategoryAxis
 Gets a value indicating whether this instance is a category axis. More...
 
(id< SCIRangeProtocol >) - getUndefinedRange
 Returns an undefined SCIRange, called internally by SciChart to reset the Visible Range of an axis to an undefined state. More...
 
(id< SCIRangeProtocol >) - getDefaultNonZeroRange
 Returns a defulat non zero SCIRange, called internally by SciChart to reset the Visible Range of an axis to an undefined state. More...
 
(BOOL) - isRangeOfValidType:
 Checks whether the range is of valid type for this axis. More...
 
(void) - coerceVisibleRange
 When overridden in derived class, changes value of the VisibleRange according to axis requirements before it is applied. More...
 
(BOOL) - isVisibleRangeValid
 Checks if the VisibleRange is valid, e.g. More...
 
(SCITickCoordinates *) - CalculateTicks
 Overridden by derived types, called internally to calculate MinorTicks, MajorTicks before Axis drawing. More...
 
(void) - calculateDelta
 Calculates the deltas for use in this render pass. More...
 
(id< SCIDeltaCalculatorProtocol >) - getDeltaCalculator
 Returns an instance of a SCIDeltaCalculator which is used to compute the data-values of MajorDelta, MinorDelta @discussion Overridden by derived types to allow calculations specific to that axis type. More...
 
(uint) - getMaxAutoTicks
 Calculates max auto ticks amount, which is >= 1. More...
 
(void) - assertRangeType:
 Asserts the type passed in is supported by the current axis implementation. More...
 
- Instance Methods inherited from <SCIAxisCoreProtocol>
(id< SCIRangeProtocol >) - getMaximumRange
 Method calculates axis' maximal visible range based on all renderable series' data attached to that axis. More...
 
(BOOL) - isLogarithmicAxis
 Gets or sets whether the current axis is an logarithmic or not. More...
 
(BOOL) - hasValidVisibleRange
 Gets whether VisibleRange is valid, e.g. More...
 
(BOOL) - hasDefaultVisibleRange
 Gets whether Axis has default visible range. More...
 
(void) - animateVisibleRangeTo:AnimationTime:
 Animates the visible range of the axis to the destination visible range, over the specified duration. More...
 
(void) - animateVisibleRangeTo:AnimationTime:andVelocity:
 
(void) - animateVisibleRangeTo:AnimationTime:velocity:rangeLimit:
 
(BOOL) - trySetOrAnimateVisibleRange:
 Method set visible range for axis. More...
 
(BOOL) - trySetOrAnimateVisibleRange:duration:
 Method set visible range for axis. More...
 
(BOOL) - isValidRange:
 Gets whether the passed range is valid. More...
 
(void) - validateAxis
 Called to check the axis properties are valid for rendering. More...
 
(id< SCICoordinateCalculatorProtocol >) - getCurrentCoordinateCalculator
 Gets the current SCICoordinateCalculator for this axis, based on visible range and axis type. More...
 
(double) - getAxisSize
 Gets the size of the axis in the Viewport. More...
 
(double) - getCoordinate:
 Gets the coordinate from data-value. More...
 
(SCIGenericType- getDataValue:
 Gets the data-value from coordinate. More...
 
(double) - getAxisOffset
 Returns the offset of the Axis. More...
 
(void) - free
 Method stops all axis internal timers used for animations. More...
 
(id< SCICallbackHelperProtocol >) - registerVisibleRangeChangedCallback:
 Called when visible range is changed. More...
 
- Instance Methods inherited from <SCIInvalidatableElementProtocol>
(void) - invalidateElement
 Asynchronously requests that the element redraws itself plus children. More...
 

Protected Attributes

__weak id< SCIChartSurfaceProtocol_parentSurface
 

Properties

id< SCITickCoordinatesProviderProtocoltickCoordinatesProvider
 Gets or sets a SCITickCoordinatesProvider instance on current axis @discussion Used to transform the data-values received from TickProvider instance to the coordinates for Axis gridlines, ticks and labels drawing. More...
 
BOOL isStaticAxis
 Gets or sets whether current Axis is a static axis. More...
 
id< SCILabelProviderProtocollabelProvider
 Gets or sets a SCILabelProvider instance @discussion Used to programmatically override the formatting of text and cursor labels. More...
 
SCIRangeChangedCallbackHandlerrangeCallbackHandler
 Axis visible range changes callback controller. More...
 
- Properties inherited from <SCIAxisCoreProtocol>
id< SCIRangeProtocolvisibleRange
 Gets or sets the VisibleRange of the Axis. More...
 
id< SCIRangeProtocolgrowBy
 Gets or sets the GrowBy (0.1, 0.2) will increase the axis extents by 10% (min) and 20% (max) outside of the data range. More...
 
SCIGenericType minorDelta
 Gets or sets axis minor ticks spacing. More...
 
SCIGenericType majorDelta
 Gets or sets axis major ticks spacing. More...
 
id< SCIChartSurfaceProtocolparentSurface
 Gets or sets the parent that this Axis belongs to. More...
 
NSString * axisTitle
 Gets or sets the axis title. More...
 
BOOL flipCoordinates
 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. More...
 
NSString * textFormatting
 Gets or sets the TextFormatting string for tick labels on this axis. More...
 
SCIGenericType minimalZoomConstrain
 Gets or sets the minimal zoom constrain of the axis @discussion Used to set the minimum distance between Min and Max of the VisibleRange. More...
 
SCIGenericType maximalZoomConstrain
 Gets or sets the maximum zoom constrain of the axis @discussion Used to set the maximum distance between Min and Max of the VisibleRange. More...
 
int minorsPerMajor
 Gets or sets the number of minor delta ticks per major tick minor ticks count between major ticks. More...
 
int maxAutoTicks
 Gets or sets the max ticks. More...
 
BOOL autoTicks
 Gets or sets value, that indicates whether calculate ticks automatically. More...
 
id< SCITickProviderProtocoltickProvider
 Gets or sets a SCITickProvider instance on current axis Used to compute the data-values of axis gridlines, ticks and labels. More...
 
SCIAutoRange autoRange
 Gets or sets AutoRange mode. More...
 
NSString * cursorTextFormatting
 Gets or sets the text formatting string for labels on this cursor. More...
 
BOOL isXAxis
 Gets or sets whether the current axis is an X-Axis or not. More...
 
BOOL animateVisibleRangeChanges
 Gets or sets the animated VisibleRange of the Axis @discussion When this property is set, the axis animates the Visible Range to the new value over a duration. More...
 
double animatedChangeDuration
 Gets or sets the Duration used when animates the visible range of the axis to the destination visible range. More...
 
UIView * titleCustomView
 Gets or sets Title's custom view. More...
 

Detailed Description

Provides base class for 2D Axis types throughout the SciChart SDK.

Method Documentation

◆ assertRangeType:()

- (void) assertRangeType: (id< SCIRangeProtocol >)  range

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

Parameters
rangeRange type
See also
SCIDataType

◆ calculateDelta()

- (void) calculateDelta

Calculates the deltas for use in this render pass.

◆ CalculateTicks()

- (SCITickCoordinates *) CalculateTicks

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

◆ coerceVisibleRange()

- (void) coerceVisibleRange

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

◆ getDefaultNonZeroRange()

- (id<SCIRangeProtocol>) getDefaultNonZeroRange

Returns a defulat non zero SCIRange, called internally by SciChart to reset the Visible Range of an axis to an undefined state.

See also
SCIRangeProtocol

◆ getDeltaCalculator()

- (id<SCIDeltaCalculatorProtocol>) getDeltaCalculator

Returns an instance of a SCIDeltaCalculator which is used to compute the data-values of MajorDelta, MinorDelta @discussion Overridden by derived types to allow calculations specific to that axis type.

Returns
SCIDeltaCalculatorProtocol instance

◆ getMaxAutoTicks()

- (uint) getMaxAutoTicks

Calculates max auto ticks amount, which is >= 1.

◆ getUndefinedRange()

- (id<SCIRangeProtocol>) getUndefinedRange

Returns an undefined SCIRange, called internally by SciChart to reset the Visible Range of an axis to an undefined state.

See also
SCIRangeProtocol

◆ isCategoryAxis()

- (BOOL) isCategoryAxis

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

◆ isRangeOfValidType:()

- (BOOL) isRangeOfValidType: (id< SCIRangeProtocol >)  range

Checks whether the range is of valid type for this axis.

Parameters
rangeRange to check

◆ isVisibleRangeValid()

- (BOOL) isVisibleRangeValid

Checks if the VisibleRange is valid, e.g.

is not nil, the difference between Max and Min is positive

Field Documentation

◆ _parentSurface

- (__weak id<SCIChartSurfaceProtocol>) _parentSurface
protected

Property Documentation

◆ isStaticAxis

- (BOOL) isStaticAxis
readwritenonatomicassign

Gets or sets whether current Axis is a static axis.

◆ labelProvider

- (id<SCILabelProviderProtocol>) labelProvider
readwritenonatomicstrong

Gets or sets a SCILabelProvider instance @discussion Used to programmatically override the formatting of text and cursor labels.

◆ rangeCallbackHandler

- (SCIRangeChangedCallbackHandler*) rangeCallbackHandler
readwritenonatomicassign

Axis visible range changes callback controller.

@discussion For internal use.

◆ tickCoordinatesProvider

- (id<SCITickCoordinatesProviderProtocol>) tickCoordinatesProvider
readwritenonatomicstrong

Gets or sets a SCITickCoordinatesProvider instance on current axis @discussion Used to transform the data-values received from TickProvider instance to the coordinates for Axis gridlines, ticks and labels drawing.


The documentation for this class was generated from the following file: