SCINumericAxis Class Reference

Axis that represents numeric values and provides tools for layout numeric data in SciChart. More...

#import <SCINumericAxis.h>

Inheritance diagram for SCINumericAxis:
SCIAxisBase SCIAxisCore <SCIAxis2DProtocol> <SCIThemeableProtocol> <SCIAxisCoreProtocol> <SCIAxisCoreProtocol> <SCIDrawableProtocol> <SCIInvalidatableElementProtocol> <SCIInvalidatableElementProtocol> SCICategoryNumericAxis SCILogarithmicNumericAxis

Class Methods

(NSString *) + defaultTextFormatting
 Default text formatting for SCINumericAxis More...
 
(NSString *) + defaultCursorTextFormatting
 Default cursor text formatting used by SCIChartModifierProtocol for SCINumericAxis More...
 
- Class Methods inherited from SCIAxisBase
(NSString *) + defaultAxisId
 

Properties

SCIScientificNotation scientificNotation
 
NSNumberFormatter *numberFormatter __deprecated
 Gets or sets axis label number formatter @discussion If value is not set labels are formated with textFormatting. More...
 
- Properties inherited from SCIAxisBase
BOOL isLicenseValid
 
- Properties inherited from SCIAxisCore
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...
 
- Properties inherited from <SCIAxis2DProtocol>
NSString * axisId
 Gets or sets the string Id of this axis. More...
 
id< SCILabelProviderProtocollabelProvider
 Gets or sets a SCILabelProvider instance, which may be used to programmatically override the formatting of the text and cursor labels. More...
 
BOOL isStaticAxis
 Gets or sets whether this Axis is a static axis. More...
 
SCIAxisAlignment axisAlignment
 Gets or sets the alignment characteristics that are appliied to an Axis. More...
 
SCIActionBlock onAxisAlignmentChanged
 Called when the alignment of axis is changed. More...
 
BOOL isCenterAxis
 Gets or sets whether current Axis should be placed in the center of the chart or not. More...
 
BOOL isPrimaryAxis
 Gets or sets whether current Axis is the main one in axis collection. More...
 
BOOL isVisible
 Gets or sets the visibility of the Axis. More...
 
id< SCIRangeProtocolvisibleRangeLimit
 Gets or sets the VisibleRangeLimit of the Axis. More...
 
SCIRangeClipMode visibleRangeLimitMode
 Gets or sets the VisibleRangeLimitMode of the Axis @discussion This property defines which parts of VisibleRangeLimit will be used by axis. More...
 
BOOL isLabelCullingEnabled
 Gets or sets a value indicating whether label culling is enabled (when labels overlap) on this AxisPanel instance. More...
 
SCIAxisStyle * style
 Gets or sets the style of the current axis. More...
 

Additional Inherited Members

- Instance Methods inherited from SCIAxisBase
(int) - minDistanceToBounds
 Defines the minimum distance to the edge of the chart to cull axis labels. More...
 
(double) - zeroRangeGrowBy
 Method is used for adding some grow by to default zero range. More...
 
(id< SCIRenderSurfaceProtocol >) - renderSurface
 Get the RenderSurface instance off the parent SCIChartSurface. More...
 
(id< SCIRangeProtocol >) - coerceZeroRange:
 Method enlarges default zero range a little with zeroRangeGrowBy. More...
 
(SCIArrayController *) - getSupportedTypes
 Returns a list of types which current axis is designed to work with. More...
 
(SCIAxisParams *) - getAxisParams
 Gets an SCIAxisParams instance with info about the current axis setup. More...
 
(void) - drawGridLinesWithContext:WithCoordinates:
 Called internal to draw gridlines before Axis drawing. More...
 
(void) - onDrawAxis:
 Called internal to draw axis ticks before Axis drawing. More...
 
(double) - getOffsetForLabels
 Returns an offset for the axis. More...
 
(SCIGenericType- convertTickToDataValue:
 Gets the data-value from tick. More...
 
(void) - drawAxisAreaWithContext:
 Called internal to draw axis area before Axis drawing. More...
 
(BOOL) - prepareToDrawGridLines:
 Called internal to prepare gridlines before Axis drawing. More...
 
(void) - drawBandsWithContext:
 Called internal to draw bands before Axis drawing. More...
 
(void) - drawMinorGridLinesWithContext:
 Called internal to draw minor gridlines before Axis drawing. More...
 
(void) - drawMajorGridLinesWithContext:
 Called internal to draw major gridlines before Axis drawing. More...
 
(SCIArrayController *) - currentController
 returns array with data bound to axis More...
 
(id< SCIRangeProtocol >) - categoryVisibleRange
 
- Instance Methods inherited from SCIAxisCore
(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...
 
- Instance Methods inherited from <SCIAxis2DProtocol>
(id< SCIRangeProtocol >) - getDataRange
 Gets the DataRange (full extents of the data) of the Axis. More...
 
(BOOL) - isHorizontalAxis
 Gets whether this Axis is horizontal or not. More...
 
(BOOL) - isCategoryAxis
 Gets a value indicating whether this instance is a category axis. More...
 
(BOOL) - isPolarAxis
 Gets a value indicating whether this instance is a polar axis. More...
 
(BOOL) - isAxisFlipped
 Gets whether the current axis is flipped @discussion E.g. More...
 
(void) - clipRangeToVisibleRangeLimit:
 Clips range to axis' visibleRangeLimit using current visibleRangeLimitMode. More...
 
(id< SCIAxisInteractivityHelperProtocol >) - getCurrentInteractivityHelper
 Gets the current SCIAxisInteractivityHelper for this Axis. More...
 
(id< SCIRangeProtocol >) - calculateYRangeWithRenderPassInfo:
 Gets the aligned VisibleRange of the axis, with optional ZoomToFit flag. More...
 
(id< SCIRangeProtocol >) - getWindowedYRangeWithXRanges:
 Called by SCIChartSurface internally. More...
 
(void) - onBeginRenderPass
 Called internally immediately before a render pass begins. More...
 
(void) - scrollByPixels:ClipMode:
 Scrolls current VisibleRange by specified number of pixels. More...
 
(void) - scrollByPixels:ClipMode:duration:
 Scrolls current Visible Range by the specified number of pixels with the specified animation duration. More...
 
(void) - scrollByPixels:ClipMode:AnimationTime:Velocity:
 Scrolls current VisibleRange by specified number of pixels. More...
 
(void) - scrollByDataPoints:
 Translates current VisibleRange by specified number of datapoints. More...
 
(void) - scrollByDataPoints:AnimationTime:
 Translates current VisibleRange by specified number of datapoints. More...
 
(void) - zoomFrom:To:
 Performs zoom on current Axis, using fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end. More...
 
(void) - zoomFrom:To:AnimationTime:
 Performs zoom on current Axis, using fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end. More...
 
(void) - zoomByFractionMin:Max:
 Performs zoom on current Axis, using minFraction as a multuplier of range start and maxFraction as a multiplier of range end. More...
 
(void) - zoomByFractionMin:Max:AnimationTime:
 Performs zoom on current Axis, using minFraction as a multuplier of range start and maxFraction as a multiplier of range end. More...
 
(void) - scrollToPixels:WithVisibleRange:WithLimit:
 From the starting SCIRange, scrolls to a new range by the specified number of pixels, with the specified range limit. More...
 
(void) - assertDataType:
 Asserts the type passed in is supported by the current axis implementation. More...
 
(NSString *) - formatText:
 String formats the text. More...
 
(NSString *) - formatCursorText:
 String formats text for the cursor. More...
 
(void) - clear
 Clears the axis of tick-marks and labels. 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 default non zero SCIRange, called internally by SciChart to reset the Visible Range of an axis to an undefined state. More...
 
(id< SCIAxisPanelProtocol >) - axisPanel
 Returns axis panel, which is axis layout and resizing tools. More...
 
(SCIAxisHitTestProvider *) - hitTestProvider
 Returns hit test tools for axis. More...
 
(CGRect) - frame
 Returns axis frame inside SCIAxisArea. More...
 
(BOOL) - isPointWithinBounds:
 Returns true if point is within axis frame. More...
 
- Instance Methods inherited from <SCIDrawableProtocol>
(void) - onDrawAnimationWithContext:
 
(void) - onDrawWithContext:WithData:
 
(void) - prepareForDrawing
 
- Instance Methods inherited from <SCIThemeableProtocol>
(void) - applyThemeProvider:
 Applies specified theme to current instance. More...
 
- Protected Attributes inherited from SCIAxisBase
id< SCICoordinateCalculatorProtocol_currentCoordinateCalculator
 
id< SCIAxisInteractivityHelperProtocol_currentInteractivityHelper
 
SCIArrayController_supportedTypes
 
- Protected Attributes inherited from SCIAxisCore
__weak id< SCIChartSurfaceProtocol_parentSurface
 

Detailed Description

Axis that represents numeric values and provides tools for layout numeric data in SciChart.

See also
SCIAxisBase

Method Documentation

◆ defaultCursorTextFormatting()

+ (NSString *) defaultCursorTextFormatting

Default cursor text formatting used by SCIChartModifierProtocol for SCINumericAxis

◆ defaultTextFormatting()

+ (NSString *) defaultTextFormatting

Default text formatting for SCINumericAxis

Property Documentation

◆ __deprecated

- (NSNumberFormatter* numberFormatter) __deprecated
readwritenonatomicassign

Gets or sets axis label number formatter @discussion If value is not set labels are formated with textFormatting.

◆ scientificNotation

- (SCIScientificNotation) scientificNotation
readwritenonatomicassign

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