<SCIAxisCoreProtocol> Protocol Reference

Defines protocol for Axis core functionality. More...

#import <SCIAxisCoreProtocol.h>

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

Instance Methods

(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...
 

Properties

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

Defines protocol for Axis core functionality.

Method Documentation

◆ animateVisibleRangeTo:AnimationTime:()

- (void) animateVisibleRangeTo: (id< SCIRangeProtocol >)  to
AnimationTime: (float)  duration 

Animates the visible range of the axis to the destination visible range, over the specified duration.

Parameters
toThe end range
durationThe duration of the animation

◆ animateVisibleRangeTo:AnimationTime:andVelocity:()

- (void) animateVisibleRangeTo: (id< SCIRangeProtocol >)  to
AnimationTime: (float)  duration
andVelocity: (float)  __deprecated 

◆ animateVisibleRangeTo:AnimationTime:velocity:rangeLimit:()

- (void) animateVisibleRangeTo: (id< SCIRangeProtocol >)  to
AnimationTime: (float)  duration
velocity: (float)  velocity
rangeLimit: (id< SCIRangeProtocol >)  __deprecated 

◆ free()

- (void) free

Method stops all axis internal timers used for animations.

◆ getAxisOffset()

- (double) getAxisOffset

Returns the offset of the Axis.

◆ getAxisSize()

- (double) getAxisSize

Gets the size of the axis in the Viewport.

◆ getCoordinate:()

- (double) getCoordinate: (SCIGenericType value

Gets the coordinate from data-value.

Parameters
valueData-value to be converted
See also
SCIGenericType

◆ getCurrentCoordinateCalculator()

- (id <SCICoordinateCalculatorProtocol>) getCurrentCoordinateCalculator

Gets the current SCICoordinateCalculator for this axis, based on visible range and axis type.

◆ getDataValue:()

- (SCIGenericType) getDataValue: ("please use coordinate calculator to convert to data value")  __deprecated_msg

Gets the data-value from coordinate.

Parameters
pixelCoordinateCoordinate
Returns
SCIGenericType
See also
SCIGenericType

◆ getMaximumRange()

- (id <SCIRangeProtocol>) getMaximumRange

Method calculates axis' maximal visible range based on all renderable series' data attached to that axis.

See also
SCIRangeProtocol

◆ hasDefaultVisibleRange()

- (BOOL) hasDefaultVisibleRange

Gets whether Axis has default visible range.

◆ hasValidVisibleRange()

- (BOOL) hasValidVisibleRange

Gets whether VisibleRange is valid, e.g.

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

◆ isLogarithmicAxis()

- (BOOL) isLogarithmicAxis

Gets or sets whether the current axis is an logarithmic or not.

◆ isValidRange:()

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

Gets whether the passed range is valid.

Parameters
rangePassed range, that should be validated

◆ registerVisibleRangeChangedCallback:()

- (id <SCICallbackHelperProtocol>) registerVisibleRangeChangedCallback: (SCIAxisVisibleRangeChanged callback

Called when visible range is changed.

let callback: SCIAxisVisibleRangeChanged = {newRange, oldRange, isAnimated, sender in
// do important stuff here...
}
self.chartSurface.xAxis.registerVisibleRangeChangedCallback(callback)

◆ trySetOrAnimateVisibleRange:()

- (BOOL) trySetOrAnimateVisibleRange: (id< SCIRangeProtocol >)  newRange

Method set visible range for axis.

Visible range change is animated if animateVisibleRangeChanges is true and animatedChangeDuration is not zero

◆ trySetOrAnimateVisibleRange:duration:()

- (BOOL) trySetOrAnimateVisibleRange: (id< SCIRangeProtocol >)  newRange
duration: (float)  duration 

Method set visible range for axis.

Visible range change is animated if duration is not zero

◆ validateAxis()

- (void) validateAxis

Called to check the axis properties are valid for rendering.

Property Documentation

◆ animatedChangeDuration

- (double) animatedChangeDuration
readwritenonatomicassign

Gets or sets the Duration used when animates the visible range of the axis to the destination visible range.

See also
SCIRange

◆ animateVisibleRangeChanges

- (BOOL) animateVisibleRangeChanges
readwritenonatomicassign

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.

◆ autoRange

- (SCIAutoRange) autoRange
readwritenonatomicassign

Gets or sets AutoRange mode.

See also
SCIAutoRange

◆ autoTicks

- (BOOL) autoTicks
readwritenonatomicassign

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

Default is true

◆ axisTitle

- (NSString*) axisTitle
readwritenonatomiccopy

Gets or sets the axis title.

◆ cursorTextFormatting

- (NSString*) cursorTextFormatting
readwritenonatomiccopy

Gets or sets the text formatting string for labels on this cursor.

◆ flipCoordinates

- (BOOL) flipCoordinates
readwritenonatomicassign

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.

◆ growBy

- (id<SCIRangeProtocol>) growBy
readwritenonatomicstrong

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.

See also
SCIRangeProtocol

◆ isXAxis

- (BOOL) isXAxis
readwritenonatomicassign

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

◆ majorDelta

- (SCIGenericType) majorDelta
readwritenonatomicassign

Gets or sets axis major ticks spacing.

See also
SCIGenericType

◆ maxAutoTicks

- (int) maxAutoTicks
readwritenonatomicassign

Gets or sets the max ticks.

◆ maximalZoomConstrain

- (SCIGenericType) maximalZoomConstrain
readwritenonatomicassign

Gets or sets the maximum zoom constrain of the axis @discussion Used to set the maximum distance between Min and Max of the VisibleRange.

◆ minimalZoomConstrain

- (SCIGenericType) minimalZoomConstrain
readwritenonatomicassign

Gets or sets the minimal zoom constrain of the axis @discussion Used to set the minimum distance between Min and Max of the VisibleRange.

◆ minorDelta

- (SCIGenericType) minorDelta
readwritenonatomicassign

Gets or sets axis minor ticks spacing.

See also
SCIGenericType

◆ minorsPerMajor

- (int) minorsPerMajor
readwritenonatomicassign

Gets or sets the number of minor delta ticks per major tick minor ticks count between major ticks.

◆ parentSurface

- (id<SCIChartSurfaceProtocol>) parentSurface
readwritenonatomicweak

Gets or sets the parent that this Axis belongs to.

See also
SCIChartSurfaceProtocol

◆ textFormatting

- (NSString*) textFormatting
readwritenonatomiccopy

Gets or sets the TextFormatting string for tick labels on this axis.

◆ tickProvider

- (id<SCITickProviderProtocol>) tickProvider
readwritenonatomicstrong

Gets or sets a SCITickProvider instance on current axis Used to compute the data-values of axis gridlines, ticks and labels.

◆ titleCustomView

- (UIView*) titleCustomView
readwritenonatomicassign

Gets or sets Title's custom view.

◆ visibleRange

- (id<SCIRangeProtocol>) visibleRange
readwritenonatomicstrong

Gets or sets the VisibleRange of the Axis.

See also
SCIChartSurface
SCIRangeProtocol

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