XuniAxis Class Reference

Inherits from NSObject
Conforms to IXuniAxis
Declared in Axis.h

Overview

Represents an axis in the chart.

  chart

Gets or sets the chart of the axis.

@property (nonatomic) FlexChart *chart

Discussion

Gets or sets the chart of the axis.

Declared In

Axis.h

  origin

Gets or sets axis origin.

@property (nonatomic) double origin

Discussion

Gets or sets axis origin.

Declared In

Axis.h

  offset

Gets or sets axis offset after setting the origin.

@property (nonatomic) double offset

Discussion

Gets or sets axis offset after setting the origin.

Declared In

Axis.h

  axisName

@exclude.

@property (nonatomic) NSString *axisName

Discussion

@exclude.

Declared In

Axis.h

  position

Gets or sets the position of the axis relative to the plot area.

@property (nonatomic) XuniPosition position

Discussion

Gets or sets the position of the axis relative to the plot area.

Declared In

Axis.h

  title

Gets or sets the axis title.

@property (nonatomic) NSString *title

Discussion

Gets or sets the axis title.

Declared In

Axis.h

  format

Gets or sets the annotation format.

@property (nonatomic) NSString *format

Discussion

Gets or sets the annotation format.

Declared In

Axis.h

  labelAngle

Gets or sets the angle at which axis labels are drawn.

@property (nonatomic) double labelAngle

Discussion

Gets or sets the angle at which axis labels are drawn.

Declared In

Axis.h

  labelFont

Gets or sets the font of the axis labels.

@property (nonatomic) UIFont *labelFont

Discussion

Gets or sets the font of the axis labels.

Declared In

Axis.h

  labelTextColor

Gets or sets the text color of the axis labels.

@property (nonatomic) UIColor *labelTextColor

Discussion

Gets or sets the text color of the axis labels.

Declared In

Axis.h

  titleFont

Gets or sets the font of the axis title.

@property (nonatomic) UIFont *titleFont

Discussion

Gets or sets the font of the axis title.

Declared In

Axis.h

  titleTextColor

Gets or sets the text color of the axis title.

@property (nonatomic) UIColor *titleTextColor

Discussion

Gets or sets the text color of the axis title.

Declared In

Axis.h

  lineColor

Gets or sets the color of the axis line.

@property (nonatomic) UIColor *lineColor

Discussion

Gets or sets the color of the axis line.

Declared In

Axis.h

  lineWidth

Gets or sets the width of the axis line.

@property (nonatomic) double lineWidth

Discussion

Gets or sets the width of the axis line.

Declared In

Axis.h

  majorGridColor

Gets or sets the color of the major grid lines.

@property (nonatomic) UIColor *majorGridColor

Discussion

Gets or sets the color of the major grid lines.

Declared In

Axis.h

  majorGridFill

Gets or sets the fill color of the major grid.

@property (nonatomic) UIColor *majorGridFill

Discussion

Gets or sets the fill color of the major grid.

Declared In

Axis.h

  majorGridWidth

Gets or sets the width of the major grid lines.

@property (nonatomic) double majorGridWidth

Discussion

Gets or sets the width of the major grid lines.

Declared In

Axis.h

  majorTickColor

Gets or sets the color of the major tick marks.

@property (nonatomic) UIColor *majorTickColor

Discussion

Gets or sets the color of the major tick marks.

Declared In

Axis.h

  majorTickWidth

Gets or sets the width of the major tick marks.

@property (nonatomic) double majorTickWidth

Discussion

Gets or sets the width of the major tick marks.

Declared In

Axis.h

  majorTickLength

Gets or sets the length of the major tick marks.

@property (nonatomic) double majorTickLength

Discussion

Gets or sets the length of the major tick marks.

Declared In

Axis.h

  minorGridColor

Gets or sets the color of the minor grid lines.

@property (nonatomic) UIColor *minorGridColor

Discussion

Gets or sets the color of the minor grid lines.

Declared In

Axis.h

  minorGridFill

Gets or sets the fill color of the minor grid.

@property (nonatomic) UIColor *minorGridFill

Discussion

Gets or sets the fill color of the minor grid.

Declared In

Axis.h

  minorGridWidth

Gets or sets the width of the minor grid lines.

@property (nonatomic) double minorGridWidth

Discussion

Gets or sets the width of the minor grid lines.

Declared In

Axis.h

  minorTickColor

Gets or sets the color of the minor tick marks.

@property (nonatomic) UIColor *minorTickColor

Discussion

Gets or sets the color of the minor tick marks.

Declared In

Axis.h

  minorTickWidth

Gets or sets the width of the minor tick marks.

@property (nonatomic) double minorTickWidth

Discussion

Gets or sets the width of the minor tick marks.

Declared In

Axis.h

  minorTickLength

Gets or sets the length of the minor tick marks.

@property (nonatomic) double minorTickLength

Discussion

Gets or sets the length of the minor tick marks.

Declared In

Axis.h

  actualMin

Gets the actual axis minimum value.

@property (readonly) double actualMin

Discussion

Gets the actual axis minimum value.

Declared In

Axis.h

  actualMax

Gets the actual axis maximum value.

@property (readonly) double actualMax

Discussion

Gets the actual axis maximum value.

Declared In

Axis.h

  min

Gets or sets the desired axis minimum value.

@property (nonatomic) NSObject *min

Discussion

Gets or sets the desired axis minimum value.

Declared In

Axis.h

  majorGridDashes

Gets or sets the dash pattern for grid.

@property (nonatomic) NSArray<NSNumber*> *majorGridDashes

Discussion

Gets or sets the dash pattern for grid.

Declared In

Axis.h

  minorGridDashes

Gets or sets the dash pattern for grid.

@property (nonatomic) NSArray<NSNumber*> *minorGridDashes

Discussion

Gets or sets the dash pattern for grid.

Declared In

Axis.h

  max

Gets or sets the desired axis maximum value.

@property (nonatomic) NSObject *max

Discussion

Gets or sets the desired axis maximum value.

Declared In

Axis.h

  axisType

Gets the axis type (X or Y).

@property (readonly) XuniAxisType axisType

Discussion

Gets the axis type (X or Y).

Declared In

Axis.h

  isTimeAxis

Gets whether the axis contains time values.

@property (nonatomic) BOOL isTimeAxis

Discussion

Gets whether the axis contains time values.

Declared In

Axis.h

  dataIndexTimeVals

Gets axis’s time values of data index.

@property (nonatomic) NSArray *dataIndexTimeVals

Discussion

Gets axis’s time values of data index.

Declared In

Axis.h

  axisLineVisible

Gets or sets whether the axis line is visible.

@property (nonatomic) BOOL axisLineVisible

Discussion

Gets or sets whether the axis line is visible.

Declared In

Axis.h

  labelsVisible

Gets or sets whether the axis labels are visible.

@property (nonatomic) BOOL labelsVisible

Discussion

Gets or sets whether the axis labels are visible.

Declared In

Axis.h

  majorGridVisible

Gets or sets whether the axis should include major grid lines.

@property (nonatomic) BOOL majorGridVisible

Discussion

Gets or sets whether the axis should include major grid lines.

Declared In

Axis.h

  majorTickOverlap

Gets or sets the major tick mark overlap with the axis.

@property (nonatomic) double majorTickOverlap

Discussion

Gets or sets the major tick mark overlap with the axis.

Declared In

Axis.h

  majorUnit

Gets or sets the distance between axis major tick marks.

@property (nonatomic) double majorUnit

Discussion

Gets or sets the distance between axis major tick marks.

Declared In

Axis.h

  minorGridVisible

Gets or sets whether the axis should include minor grid lines.

@property (nonatomic) BOOL minorGridVisible

Discussion

Gets or sets whether the axis should include minor grid lines.

Declared In

Axis.h

  minorTickOverlap

Gets or sets the minor tick mark overlap with the axis.

@property (nonatomic) double minorTickOverlap

Discussion

Gets or sets the minor tick mark overlap with the axis.

Declared In

Axis.h

  minorUnit

Gets or sets the distance between axis minor tick marks.

@property (nonatomic) double minorUnit

Discussion

Gets or sets the distance between axis minor tick marks.

Declared In

Axis.h

  reversed

Gets or sets whether the axis is reversed.

@property BOOL reversed

Discussion

Gets or sets whether the axis is reversed.

Declared In

Axis.h

  displayedRange

Gets or sets the absolute range of values displayed in the view.

@property (nonatomic) double displayedRange

Discussion

Gets or sets the absolute range of values displayed in the view.

Declared In

Axis.h

  logBase

Gets or sets the logarithmical base of the axis.

@property (nonatomic) NSNumber *logBase

Discussion

Gets or sets the logarithmical base of the axis.

Declared In

Axis.h

  scale

Gets or sets the relative range of values displayed in the view.

@property (nonatomic) double scale

Discussion

Gets or sets the relative range of values displayed in the view.

Declared In

Axis.h

  scrollPosition

Gets or sets the relative scroll position of the axis.

@property (nonatomic) double scrollPosition

Discussion

Gets or sets the relative scroll position of the axis.

Declared In

Axis.h

  annoSize

Gets or sets the size.

@property (readonly) XuniSize *annoSize

Discussion

Gets or sets the size.

Declared In

Axis.h

  gestureProportion

Gets or sets the proportional relation for pinch gestures.

@property CGFloat gestureProportion

Discussion

Gets or sets the proportional relation for pinch gestures.

Declared In

Axis.h

  desiredSize

Gets or sets the size desired.

@property XuniSize *desiredSize

Discussion

Gets or sets the size desired.

Declared In

Axis.h

  axrect

Gets or sets the ax rect.

@property (readonly) XuniRect *axrect

Discussion

Gets or sets the ax rect.

Declared In

Axis.h

  overlappingLabels

Gets or sets whether the axis is overlapping labels.

@property (nonatomic) XuniChartOverlappingLabels overlappingLabels

Discussion

Gets or sets whether the axis is overlapping labels.

Declared In

Axis.h

  labelLoading

Gets or sets the labelLoading event.

@property (nonatomic) XuniEvent<XuniLabelLoadingEventArgs*> *labelLoading

Discussion

Gets or sets the labelLoading event.

Declared In

Axis.h

  isHandleXFAxisLabelLoading

Gets or sets whether handle XF axis label loading event.

@property (nonatomic) BOOL isHandleXFAxisLabelLoading

Discussion

Gets or sets whether handle XF axis label loading event.

Declared In

Axis.h

  above

Gets or sets whether the axis should above the series.

@property (nonatomic) BOOL above

Discussion

Gets or sets whether the axis should above the series.

Declared In

Axis.h

  gridLineIsExsit

Gets or sets whether the grid line is exsit.

@property (nonatomic) BOOL gridLineIsExsit

Discussion

Gets or sets whether the grid line is exsit.

Declared In

Axis.h

– hasMore

Gets a boolean type value.

- (BOOL)hasMore

Return Value

a boolean type value.

Discussion

Gets a boolean type value.

Declared In

Axis.h

– hasLess

Gets a boolean type value.

- (BOOL)hasLess

Return Value

a boolean type value.

Discussion

Gets a boolean type value.

Declared In

Axis.h

– showMore

Gets a boolean type value.

- (void)showMore

Return Value

a boolean type value.

Discussion

Gets a boolean type value.

Declared In

Axis.h

– showLess

Gets a boolean type value.

- (void)showLess

Return Value

a boolean type value.

Discussion

Gets a boolean type value.

Declared In

Axis.h

– scrollTo:position:

Scrolls the axis to the particular data value

- (void)scrollTo:(double)dataValue position:(XuniAxisScrollPosition)position

Parameters

dataValue

the value to scroll to
position

the position of relative data positioning

Discussion

Scrolls the axis to the particular data value

Declared In

Axis.h

– init

Initialize an instance for Axis.

- (instancetype)init

Return Value

an instance for Axis.

Discussion

Initialize an instance for Axis.

Declared In

Axis.h

– initWithPosition:forChart:

Initialize an instance for Axis.

- (id)initWithPosition:(XuniPosition)position forChart:(FlexChart *)chart

Parameters

position

the postion of axis.
chart

the chart.

Return Value

an instance of Axis.

Discussion

Initialize an instance for Axis.

Declared In

Axis.h

– getHeight:

Gets axis height.

- (double)getHeight:(XuniRenderEngine *)engine

Parameters

engine

the engine.

Return Value

the axis height.

Discussion

Gets axis height.

Declared In

Axis.h

– updateActualLimits:dataMin:dataMax:labels:values:

Update actual axis limits based on specified data range.

- (void)updateActualLimits:(XuniDataType)dataType dataMin:(double)dataMin dataMax:(double)dataMax labels:(NSArray *)labels values:(NSArray *)values

Parameters

dataType

the data type.
dataMin

the minimun data.
dataMax

the maximun data.
labels

the labels of axis.
values

the values of axis.

Discussion

Update actual axis limits based on specified data range.

Declared In

Axis.h

– updateActualLimits:dataMin:dataMax:

Update actual axis limits based on specified data range.

- (void)updateActualLimits:(XuniDataType)dataType dataMin:(double)dataMin dataMax:(double)dataMax

Parameters

dataType

the data type.
dataMin

the minimun data.
dataMax

the maximun data.

Discussion

Update actual axis limits based on specified data range.

Declared In

Axis.h

– layout:plotRect:

Layout axis.

- (void)layout:(XuniRect *)axisRect plotRect:(XuniRect *)plotRect

Parameters

axisRect

the rect of axis.
plotRect

the plot rect of axis.

Discussion

Layout axis.

Declared In

Axis.h

– render:isOverlap:

Render the axis.

- (void)render:(XuniRenderEngine *)engine isOverlap:(XuniChartOverlappingLabels)overlap

Parameters

engine

the engine.
overlap

the type of overlap for the label.

Discussion

Render the axis.

Declared In

Axis.h

– convert:

Gets the converted value from data to pixel coordinate.

- (double)convert:(double)val

Parameters

val

value.

Return Value

the converted value from data to pixel coordinate.

Discussion

Gets the converted value from data to pixel coordinate.

Declared In

Axis.h

– convertBack:

Gets the converted value from pixel to data coordinate.

- (double)convertBack:(double)val

Parameters

val

value.

Return Value

the converted value from pixel to data coordinate.

Discussion

Gets the converted value from pixel to data coordinate.

Declared In

Axis.h

– formatValue:

Get the formatted value string.

- (NSString *)formatValue:(double)val

Parameters

val

val

Return Value

the formatted value string.

Discussion

Get the formatted value string.

Declared In

Axis.h

  rangeChanged

Occurs on axis data range change (scroll, zoom or programmatic change)

@property XuniEvent<XuniEventArgs*> *rangeChanged

Discussion

Occurs on axis data range change (scroll, zoom or programmatic change)

Declared In

Axis.h

– raiseRangeChanged

Creates event args and calls rangeChanged.

- (void)raiseRangeChanged

Discussion

Creates event args and calls rangeChanged.

Declared In

Axis.h

– refreshScrollDataValue:

Refresh ScrollDataValue.

- (void)refreshScrollDataValue:(double)scrollPosition

Parameters

scrollPosition

the scrollPosition value use for caculating the ScrollDataValue.

Discussion

Refresh ScrollDataValue.

Declared In

Axis.h