Interface IAxis

Defines the base interface to an Axis used throughout SciChart

Implements

IAxisCore

IDrawable

IAxisGridLinesDrawable

IHitTestable

IContextProvider

IUpdatable

layoutManagers.ILayoutable

IRenderSurfaceChangedListener

IChartResizeListener

Namespace:

Assembly: .dll

Syntax

public interface IAxis extends IAxisCore, IDrawable, IAxisGridLinesDrawable, IHitTestable, IContextProvider, IUpdatable, layoutManagers.ILayoutable, IRenderSurfaceChangedListener, IChartResizeListener

Methods

getAutoFitMarginalLabels()

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

Declaration

public abstract boolean getAutoFitMarginalLabels()

Returns

Type	Description
boolean	True if auto fit marginals label mode is enabled

getAxisAlignment()

Gets the com.scichart.charting.visuals.axes.AxisAlignment for this Axis.

Declaration

public abstract AxisAlignment getAxisAlignment()

Returns

Type	Description
AxisAlignment	The axis alignment value

getAxisInfoProvider()

Gets the IAxisInfoProvider instance associated with this axis.

Declaration

public abstract IAxisInfoProvider getAxisInfoProvider()

Returns

Type	Description
IAxisInfoProvider	The current IAxisInfoProvider instance.

getAxisLabelRotation()

Declaration

public abstract Integer getAxisLabelRotation()

Returns

Type	Description
Integer

getAxisLayoutState()

Gets current AxisLayoutState for this axis instance

Declaration

public abstract AxisLayoutState getAxisLayoutState()

Returns

Type	Description
AxisLayoutState	The current AxisLayoutState for this axis instance

getAxisModifierSurface()

Gets the axis modifier surface, which is used to place tooltips on this Axis

Declaration

public abstract IAxisModifierSurface getAxisModifierSurface()

Returns

Type	Description
IAxisModifierSurface	The IAxisModifierSurface for this Axis

getAxisOffset()

Gets offset, which is used by com.scichart.charting.numerics.coordinateCalculators.ICoordinateCalculator of this Axis

Declaration

public abstract int getAxisOffset()

Returns

Type	Description
int	offset of this Axis

getAxisTickLabelStyle()

Gets style for axis tick labels

Declaration

public abstract AxisTickLabelStyle getAxisTickLabelStyle()

Returns

Type	Description
AxisTickLabelStyle	The style for axis tick labels

getAxisTitleGravity()

Gets axis title gravity

Declaration

public abstract int getAxisTitleGravity()

Returns

Type	Description
int	The axis title gravity

getAxisTitleMarginBottom()

Gets the bottom margin of the IAxis instance in pixels.

Declaration

public abstract int getAxisTitleMarginBottom()

Returns

Type	Description
int	The bottom margin of the IAxis instance in pixels.

getAxisTitleMarginLeft()

Gets the left margin of the IAxis instance in pixels.

Declaration

public abstract int getAxisTitleMarginLeft()

Returns

Type	Description
int	The left margin of the IAxis instance in pixels.

getAxisTitleMarginRight()

Gets the right margin of the IAxis instance in pixels.

Declaration

public abstract int getAxisTitleMarginRight()

Returns

Type	Description
int	The right margin of the IAxis instance in pixels.

getAxisTitleMarginTop()

Gets the top margin of the IAxis instance in pixels.

Declaration

public abstract int getAxisTitleMarginTop()

Returns

Type	Description
int	The top margin of the IAxis instance in pixels.

getAxisTitleOrientation()

Gets axis title orientation

Declaration

public abstract AxisTitleOrientation getAxisTitleOrientation()

Returns

Type	Description
AxisTitleOrientation	The axis title orientation

getAxisTitlePlacement()

Gets axis title placement

Declaration

public abstract AxisTitlePlacement getAxisTitlePlacement()

Returns

Type	Description
AxisTitlePlacement	The axis title placement

getCurrentInteractivityHelper()

Gets the current com.scichart.charting.visuals.axes.IAxisInteractivityHelper for this Axis

Declaration

public abstract IAxisInteractivityHelper getCurrentInteractivityHelper()

Returns

Type	Description
IAxisInteractivityHelper	The current com.scichart.charting.visuals.axes.IAxisInteractivityHelper for this Axis

getFixedSize()

Declaration

public abstract Integer getFixedSize()

Returns

Type	Description
Integer

getIsAxisFlipped()

Gets whether this axis is flipped (e.g YAxis on the bottom or top, or XAxis on the left or right)

Declaration

public abstract boolean getIsAxisFlipped()

Returns

Type	Description
boolean	True if axis has flipped coordinates

getIsLabelCullingEnabled()

Gets a value indicating whether Label Culling is enabled (when labels overlap) on this axis instance

Declaration

public abstract boolean getIsLabelCullingEnabled()

Returns

Type	Description
boolean	True if tick labels culling is enabled

getIsPrimaryAxis()

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

Declaration

public abstract boolean getIsPrimaryAxis()

Returns

Type	Description
boolean	The isPrimaryAxis value

getOrientation()

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

Declaration

public abstract int getOrientation()

Returns

Type	Description
int	The orientation value

getTickLabelStyle()

Gets the style which is used to draw all tick labels on this axis

Declaration

public abstract FontStyle getTickLabelStyle()

Returns

Type	Description
FontStyle	The tick label style

getTitleStyle()

Gets the style which is used to draw axis title

Declaration

public abstract FontStyle getTitleStyle()

Returns

Type	Description
FontStyle	The axis title style

getWindowedYRange(Map<String,coordinateCalculators.ICoordinateCalculator> xCoordCalcs)

Called by the SciChartSurface internally. Returns the max range only for that axis (by the data-series on it), based on xRanges

"windowed" = "displayed in current viewport"

Note:uses GrowBy()

Declaration

public abstract IRange getWindowedYRange(Map<String,coordinateCalculators.ICoordinateCalculator> xCoordCalcs)

Parameters

Type	Name	Description
Map<String,ICoordinateCalculator>	xCoordCalcs	Calculates the max range based on corresponding x coordinate calculators

Returns

Type	Description
IRange	The calculated windowed YRange

hitTest(Comparable value)

Perform a HitTest on this Axis at specified data point

Declaration

public abstract AxisInfo hitTest(Comparable value)

Parameters

Type	Name	Description
Comparable	value	data value for hit test

Returns

Type	Description
AxisInfo	The AxisInfo which contains the HitTest results

isCategoryAxis()

Deprecated. Please use #getCurrentCoordinateCalculator() and ICoordinateCalculator#isCategoryAxisCalculator()

Gets the value indicating whether this instance is a category axis

Declaration

public abstract boolean isCategoryAxis()

Returns

Type	Description
boolean	True if this instance is category axis

isCenterAxis()

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

Declaration

public abstract boolean isCenterAxis()

Returns

Type	Description
boolean	True if this instance is center axis

isHorizontalAxis()

Gets whether this axis is horizontal or not

Declaration

public abstract boolean isHorizontalAxis()

Returns

Type	Description
boolean	True if axis is horizontal

isXAxis()

Gets whether this axis is an X-Axis or not

Declaration

public abstract boolean isXAxis()

Returns

Type	Description
boolean	True if axis is XAxis

scroll(float pixelsToScroll, ClipMode clipMode)

Scrolls current Visible Range by the specified number of pixels

Declaration

public abstract void scroll(float pixelsToScroll, ClipMode clipMode)

Parameters

Type	Name	Description
float	pixelsToScroll	Scroll N pixels from the current visible range
ClipMode	clipMode	Defines how scrolling behaves when you reach the edge of the Axis extents. e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside

scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget)

Scrolls current Visible Range by the specified number of pixels with the specified animation duration

Declaration

public abstract void scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget)

Parameters

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

scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget, long duration)

/** Scrolls current Visible Range by the specified number of pixels with the specified animation duration

Declaration

public abstract void scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget, long duration)

Parameters

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

scroll(float pixelsToScroll, ClipMode clipMode, long duration)

Scrolls current Visible Range by the specified number of pixels with the specified animation duration

Declaration

public abstract void scroll(float pixelsToScroll, ClipMode clipMode, long duration)

Parameters

Type	Name	Description
float	pixelsToScroll	Scroll N pixels from the current visible range
ClipMode	clipMode	Defines how scrolling behaves when you reach the edge of the Axis extents. e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside
long	duration	The duration of animation when zooming to extents

setAutoFitMarginalLabels(boolean autoFitMarginalLabels)

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

Declaration

public abstract void setAutoFitMarginalLabels(boolean autoFitMarginalLabels)

Parameters

Type	Name	Description
boolean	autoFitMarginalLabels	The new autoFitMarginalLabels value

setAxisAlignment(AxisAlignment axisAlignment)

Sets the com.scichart.charting.visuals.axes.AxisAlignment for this Axis.

Declaration

public abstract void setAxisAlignment(AxisAlignment axisAlignment)

Parameters

Type	Name	Description
AxisAlignment	axisAlignment	The new axis alignment value

setAxisInfoProvider(IAxisInfoProvider axisInfoProvider)

Sets the IAxisInfoProvider instance associated with this axis.

Declaration

public abstract void setAxisInfoProvider(IAxisInfoProvider axisInfoProvider)

Parameters

Type	Name	Description
IAxisInfoProvider	axisInfoProvider	New IAxisInfoProvider instance.

setAxisTickLabelStyle(AxisTickLabelStyle axisTickLabelStyle)

Sets style for axis tick labels

Declaration

public abstract void setAxisTickLabelStyle(AxisTickLabelStyle axisTickLabelStyle)

Parameters

Type	Name	Description
AxisTickLabelStyle	axisTickLabelStyle	The new style for axis tick labels

setAxisTitleGravity(int axisTitleGravity)

Sets axis title gravity

Declaration

public abstract void setAxisTitleGravity(int axisTitleGravity)

Parameters

Type	Name	Description
int	axisTitleGravity	The new axis title gravity

setAxisTitleMargins(int margin)

Sets the axis title margins, in pixels

Declaration

public abstract void setAxisTitleMargins(int margin)

Parameters

Type	Name	Description
int	margin	the left, top, right and bottom margin size.

setAxisTitleMargins(int left, int top, int right, int bottom)

Sets the axis title margins, in pixels

Declaration

public abstract void setAxisTitleMargins(int left, int top, int right, int bottom)

Parameters

Type	Name	Description
int	left	the left margin size.
int	top	the top margin size.
int	right	the right margin size.
int	bottom	the bottom margin size.

setAxisTitleOrientation(AxisTitleOrientation axisTitleOrientation)

Sets axis title orientation

Declaration

public abstract void setAxisTitleOrientation(AxisTitleOrientation axisTitleOrientation)

Parameters

Type	Name	Description
AxisTitleOrientation	axisTitleOrientation	The new axis title orientation

setAxisTitlePlacement(AxisTitlePlacement axisTitlePlacement)

Sets axis title placement

Declaration

public abstract void setAxisTitlePlacement(AxisTitlePlacement axisTitlePlacement)

Parameters

Type	Name	Description
AxisTitlePlacement	axisTitlePlacement	The new axis title placement value

setIsCenterAxis(boolean isCenterAxis)

Sets whether current Axis should placed in the center of chart or not

Declaration

public abstract void setIsCenterAxis(boolean isCenterAxis)

Parameters

Type	Name	Description
boolean	isCenterAxis	The new isCenterAxis value

setIsLabelCullingEnabled(boolean isLabelCullingEnabled)

Sets a value indicating whether Label Culling is enabled (when labels overlap) on this axis instance

Declaration

public abstract void setIsLabelCullingEnabled(boolean isLabelCullingEnabled)

Parameters

Type	Name	Description
boolean	isLabelCullingEnabled	The isLabelCullingEnabled value

setIsPrimaryAxis(boolean isPrimaryAxis)

Sets whether current Axis is the main one in axis collection.

Declaration

public abstract void setIsPrimaryAxis(boolean isPrimaryAxis)

Parameters

Type	Name	Description
boolean	isPrimaryAxis	The new isPrimaryAxis value

setIsXAxis(boolean isXAxis)

Sets whether this axis is an X-Axis or not

Declaration

public abstract void setIsXAxis(boolean isXAxis)

Parameters

Type	Name	Description
boolean	isXAxis	The new isXAxis value

setMargins(int margin)

Deprecated. use #setAxisTitleMargins(int) instead

Sets the axis title margins, in pixels

Declaration

public abstract void setMargins(int margin)

Parameters

Type	Name	Description
int	margin	the left, top, right and bottom margin size.

setMargins(int left, int top, int right, int bottom)

Deprecated. use #setAxisTitleMargins(int, int, int, int) instead

Sets the axis title margins, in pixels

Declaration

public abstract void setMargins(int left, int top, int right, int bottom)

Parameters

Type	Name	Description
int	left	the left margin size.
int	top	the top margin size.
int	right	the right margin size.
int	bottom	the bottom margin size.

setOrientation(int orientation)

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

Declaration

public abstract void setOrientation(int orientation)

Parameters

Type	Name	Description
int	orientation	The new orientation value

setTickLabelStyle(FontStyle tickLabelStyle)

Sets the style which is used to draw all tick labels on this axis

Declaration

public abstract void setTickLabelStyle(FontStyle tickLabelStyle)

Parameters

Type	Name	Description
FontStyle	tickLabelStyle	The new tick label style

setTitleStyle(FontStyle titleStyle)

Sets the style which is used to draw axis title

Declaration

public abstract void setTitleStyle(FontStyle titleStyle)

Parameters

Type	Name	Description
FontStyle	titleStyle	The new axis title style

updateAxisMeasurements()

Updates measurements of axis for proper layout of its content

Declaration

public abstract void updateAxisMeasurements()

updateCore(RenderPassState renderPassState)

Performs core update of axis

Declaration

public abstract void updateCore(RenderPassState renderPassState)

Parameters

Type	Name	Description
RenderPassState	renderPassState	The RenderPassState instance for current render pass

zoom(float fromCoordinate, float toCoordinate)

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

Declaration

public abstract void zoom(float fromCoordinate, float toCoordinate)

Parameters

Type	Name	Description
float	fromCoordinate	The coordinate of new range start in pixels
float	toCoordinate	The coordinate of new range end in pixels

zoom(float fromCoordinate, float toCoordinate, long duration)

Performs zoom on current axis, using fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end with the specified animation duration

Declaration

public abstract void zoom(float fromCoordinate, float toCoordinate, long duration)

Parameters

Type	Name	Description
float	fromCoordinate	The coordinate of new range start in pixels
float	toCoordinate	The coordinate of new range end in pixels
long	duration	The duration of animation when zooming to extents

zoomBy(double minFraction, double maxFraction)

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

Declaration

public abstract void zoomBy(double minFraction, double maxFraction)

Parameters

Type	Name	Description
double	minFraction	The multiplier of range start
double	maxFraction	The multiplier of range end

zoomBy(double minFraction, double maxFraction, long duration)

Performs zoom on current axis, using minFraction as a multiplier of range start and maxFraction as a multiplier of range end with the specified animation duration

Declaration

public abstract void zoomBy(double minFraction, double maxFraction, long duration)

Parameters

Type	Name	Description
double	minFraction	The multiplier of range start
double	maxFraction	The multiplier of range end
long	duration	The duration of animation when zooming to extents

Implements

IAxisCore

IDrawable

IAxisGridLinesDrawable

IHitTestable

IContextProvider

IUpdatable

ILayoutable

IRenderSurfaceChangedListener

IChartResizeListener