ISCIAxis Protocol Reference


                        
                        
                        isPrimaryAxis

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

Note

This is the axis which is responsible for drawing grid lines.

Declaration

Objective-C

@property (nonatomic) BOOL isPrimaryAxis;


                        
                        
                        isXAxis

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

Declaration

Objective-C

@property (nonatomic) BOOL isXAxis;


                        
                        
                        isCenterAxis

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

Declaration

Objective-C

@property (nonatomic) BOOL isCenterAxis;


                        
                        
                        isCategoryAxis

Deprecated

Please use currentCoordinateCalculator ICoordinateCalculator.isCategoryAxisCalculator

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

Declaration

Objective-C

@property (nonatomic, readonly) BOOL isCategoryAxis;


                        
                        
                        isHorizontalAxis

Gets whether this axis is horizontal or not.

Declaration

Objective-C

@property (nonatomic, readonly) BOOL isHorizontalAxis;


                        
                        
                        isAxisFlipped

Gets whether this axis is flipped (e.g Y-Axis on the bottom or top, or X-Axis on the left or right).

Declaration

Objective-C

@property (nonatomic, readonly) BOOL isAxisFlipped;


                        
                        
                        axisAlignment

Gets or sets the SCIAxisAlignment for this Axis.

Declaration

Objective-C

@property (nonatomic) SCIAxisAlignment axisAlignment;


                        
                        
                        orientation

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

Declaration

Objective-C

@property (nonatomic) SCIOrientation orientation;


                        
                        
                        isLabelCullingEnabled

Gets or sets a value indicating whether label culling is enabled (when labels overlap) on this axis instance.

Declaration

Objective-C

@property (nonatomic) BOOL isLabelCullingEnabled;


                        
                        
                        autoFitMarginalLabels

Gets a value indicating whether marginal labels get shifted to fit inside an axis when too long.

Declaration

Objective-C

@property (nonatomic) BOOL autoFitMarginalLabels;


                        
                        
                        axisTitlePlacement

Gets or sets axis title placement.

Declaration

Objective-C

@property (nonatomic) SCIAxisTitlePlacement axisTitlePlacement;


                        
                        
                        axisTitleOrientation

Gets or sets axis title orientation.

Declaration

Objective-C

@property (nonatomic) SCIAxisTitleOrientation axisTitleOrientation;


                        
                        
                        axisTitleAlignment

Gets or sets axis title alignment.

Declaration

Objective-C

@property (nonatomic) SCIAlignment axisTitleAlignment;


                        
                        
                        axisTitleMargins

Defines axis title margins.

Note

Defines spacing to use when laying out content in the view.

Declaration

Objective-C

@property (nonatomic) UIEdgeInsets axisTitleMargins;


                        
                        
                        axisTickLabelStyle

Defines style for axis tick labels.

Declaration

Objective-C

@property (nonatomic, strong) SCIAxisTickLabelStyle *_Nonnull axisTickLabelStyle;


                        
                        
                        currentInteractivityHelper

Gets the current ISCIAxisInteractivityHelper for this Axis.

Declaration

Objective-C

@property (strong, readonly) id<ISCIAxisInteractivityHelper> _Nonnull currentInteractivityHelper;


                        
                        
                        -getWindowedYRangeWithXRanges:

Called by the SCIChartSurface internally.

Note

Returns the max range only for that axis(by the data-series on it)

Declaration

Objective-C

- (nonnull id<ISCIRange>)getWindowedYRangeWithXRanges:
    (nullable NSDictionary<NSString *, id<ISCICoordinateCalculator>> *)
        xCoordCalcs;

Parameters


                                    xCoordCalcs

Calculates the max range based on corresponding x coordinate calculators.

Return Value

The calculated windowed YRange.


                        
                        
                        -scrollByPixels:clipMode:

Scrolls current ISCIAxisCore.visibleRange by specified number of pixels.

Note

e.g. SCIClipMode_ClipAtExtents prevents panning outside of the Axis, SCIClipMode_None allows panning outside.

Declaration

Objective-C

- (void)scrollByPixels:(CGFloat)pixelsToScroll clipMode:(SCIClipMode)clipMode;

Parameters

`pixelsToScroll`	Scroll N pixles from the current visible range.
`clipMode`	Defines how scrolling behaves when you reach the edge of the Axis extents.


                        
                        
                        -scrollByPixels:clipMode:duration:

Scrolls current ISCIAxisCore.visibleRange by the specified number of pixels with the specified animation duration.

Note

e.g. SCIClipMode_ClipAtExtents prevents panning outside of the Axis, SCIClipMode_None allows panning outside.

Declaration

Objective-C

- (void)scrollByPixels:(CGFloat)pixelsToScroll
              clipMode:(SCIClipMode)clipMode
              duration:(NSTimeInterval)duration;

Parameters

`pixelsToScroll`	Scroll N pixels from the current visible range
`clipMode`	Defines how scrolling behaves when you reach the edge of the Axis extents.
`duration`	The duration of animation when zooming to extents.


                        
                        
                        -scrollByPixels:clipMode:clipTarget:

Scrolls current ISCIAxisCore.visibleRange by the specified number of pixels with the specified animation duration.

Declaration

Objective-C

- (void)scrollByPixels:(CGFloat)pixelsToScroll
              clipMode:(SCIClipMode)clipMode
            clipTarget:(SCIClipModeTarget)clipTarget;

Parameters

`pixelsToScroll`	Scroll N pixels from the current visible range.
`clipMode`	Defines how scrolling behaves when you reach the edge of the Axis extents.
`clipTarget`	Defines target which is used for clipping.


                        
                        
                        -scrollByPixels:clipMode:clipTarget:duration:

Scrolls current ISCIAxisCore.visibleRange by the specified number of pixels with the specified animation duration.

Declaration

Objective-C

- (void)scrollByPixels:(CGFloat)pixelsToScroll
              clipMode:(SCIClipMode)clipMode
            clipTarget:(SCIClipModeTarget)clipTarget
              duration:(NSTimeInterval)duration;

Parameters

`pixelsToScroll`	Scroll N pixels from the current visible range.
`clipMode`	Defines how scrolling behaves when you reach the edge of the Axis extents.
`clipTarget`	Defines target which is used for clipping.
`duration`	The duration of animation when zooming to extents.


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

Declaration

Objective-C

- (void)zoomFrom:(CGFloat)fromCoord to:(CGFloat)toCoord;

Parameters

`fromCoord`	The coordinate of new range start in pixels.
`toCoord`	The coordinate of new range end in pixels.


                        
                        
                        -zoomFrom:to:duration:

Performs zoom on current Axis, using fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end.

Declaration

Objective-C

- (void)zoomFrom:(CGFloat)fromCoord
              to:(CGFloat)toCoord
        duration:(NSTimeInterval)duration;

Parameters

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


                        
                        
                        -zoomByFractionMin:max:

Performs zoom on current Axis, using minFraction as a multuplier of range start and maxFraction as a multiplier of range end.

Declaration

Objective-C

- (void)zoomByFractionMin:(CGFloat)minFraction max:(CGFloat)maxFraction;

Parameters

`minFraction`	The miltiplier of range start.
`maxFraction`	The miltiplier of range end.


                        
                        
                        -zoomByFractionMin:max:duration:

Performs zoom on current Axis, using minFraction as a multuplier of range start and maxFraction as a multiplier of range end.

Declaration

Objective-C

- (void)zoomByFractionMin:(CGFloat)minFraction
                      max:(CGFloat)maxFraction
                 duration:(NSTimeInterval)duration;

Parameters

`minFraction`	The miltiplier of range start.
`maxFraction`	The miltiplier of range end.
`duration`	The duration of animation when zooming to extents.


                        
                        
                        -hitTestValue:

Perform a HitTest on this Axis at specified data point.

Declaration

Objective-C

- (nonnull SCIAxisInfo *)hitTestValue:(nonnull id<ISCIComparable>)value;

Parameters


                                    value

data value for hit test.

Return Value

The SCIAxisInfo which contains the HitTest results.


                        
                        
                        axisInfoProvider

Gets or sets the ISCIAxisInfoProvider instance associated with this axis.

Declaration

Objective-C

@property (nonatomic, strong) id<ISCIAxisInfoProvider> _Nonnull axisInfoProvider;


                        
                        
                        axisModifierSurface

Gets or sets the ISCIAxisInfoProvider instance associated with this axis.

Declaration

Objective-C

@property (nonatomic, strong, readonly) id<ISCIAxisModifierSurface> _Nonnull axisModifierSurface;


                        
                        
                        -updateAxisMeasurements

Updates measurements of axis for proper layout of its content.

Declaration

Objective-C

- (void)updateAxisMeasurements;


                        
                        
                        axisLayoutState

Gets current SCIAxisLayoutState for this axis instance.

Declaration

Objective-C

@property (nonatomic, strong, readonly) SCIAxisLayoutState *_Nonnull axisLayoutState;


                        
                        
                        axisOffset

Gets offset, which is used by ISCICoordinateCalculator of this Axis.

Declaration

Objective-C

@property (nonatomic, readonly) CGFloat axisOffset;


                        
                        
                        -updateCore:

Performs core update of axis.

Declaration

Objective-C

- (void)updateCore:(nonnull SCIRenderPassState *)renderPassState;

Parameters


                                    renderPassState

The SCIRenderPassState instance for current render pass.