Interface IAxis3D
Defines the base interface to and AxisBase3D used by SciChart 3D
Namespace:
Assembly: .dll
Syntax
public interface IAxis3D extends IAxisCore, IUpdatable3D, ISciChartSurface3DProvider, WorldDimensionsChangeObserver
Methods
getAxisDirection3D()
Gets the axis direction used by this axis
Declaration
public abstract AxisDirection3D getAxisDirection3D()
Returns
Type | Description |
---|---|
AxisDirection3D | The current axis direction |
getAxisTitleOffset()
Gets the offset applied to axis title drawn by this axis
Declaration
public abstract float getAxisTitleOffset()
Returns
Type | Description |
---|---|
float | The current offset |
getNegativeSideClipping()
Gets the clipping for negative axis side
Declaration
public abstract AxisSideClipping getNegativeSideClipping()
Returns
Type | Description |
---|---|
AxisSideClipping | The current negative side clipping mode |
getPlaneBorderColor()
Gets the color of axis plane border
Declaration
public abstract int getPlaneBorderColor()
Returns
Type | Description |
---|---|
int | The current plane border color |
getPlaneBorderThickness()
Gets the thickness of axis plane border
Declaration
public abstract float getPlaneBorderThickness()
Returns
Type | Description |
---|---|
float | The current plane border thickness |
getPositiveSideClipping()
Gets the clipping for positive axis side
Declaration
public abstract AxisSideClipping getPositiveSideClipping()
Returns
Type | Description |
---|---|
AxisSideClipping | The current positive side clipping mode |
getTextColor()
Gets the color of text used by axis
Declaration
public abstract int getTextColor()
Returns
Type | Description |
---|---|
int | The current text color |
getTextFont()
Gets font used by axis to draw text
Declaration
public abstract String getTextFont()
Returns
Type | Description |
---|---|
String |
getTextSize()
Gets the size of text used by axis
Declaration
public abstract float getTextSize()
Returns
Type | Description |
---|---|
float | The current text size |
getTickLabelAlignment()
Gets the TextAlignment of tick labels for the axis drawn in the 3D Viewport
Declaration
public abstract TextAlignment3D getTickLabelAlignment()
Returns
Type | Description |
---|---|
TextAlignment3D | The current tick label alignment |
getTickLabelOffset()
Gets the offset applied to tick labels drawn by this axis
Declaration
public abstract float getTickLabelOffset()
Returns
Type | Description |
---|---|
float | The current offset |
setAxisDirection3D(AxisDirection3D axisDirection3D)
Sets the axis direction used by this axis
Declaration
public abstract void setAxisDirection3D(AxisDirection3D axisDirection3D)
Parameters
Type | Name | Description |
---|---|---|
AxisDirection3D | axisDirection3D | The new axis direction |
setAxisTitleOffset(float axisTitleOffset)
Sets the offset applied to axis title drawn by this axis
Declaration
public abstract void setAxisTitleOffset(float axisTitleOffset)
Parameters
Type | Name | Description |
---|---|---|
float | axisTitleOffset | The new offset value |
setNegativeSideClipping(AxisSideClipping negativeSideClipping)
Sets the clipping for negative axis side
Declaration
public abstract void setNegativeSideClipping(AxisSideClipping negativeSideClipping)
Parameters
Type | Name | Description |
---|---|---|
AxisSideClipping | negativeSideClipping | The new negative side clipping mode |
setPlaneBorderColor(int planeBorderColor)
Sets the color of axis plane border
Declaration
public abstract void setPlaneBorderColor(int planeBorderColor)
Parameters
Type | Name | Description |
---|---|---|
int | planeBorderColor | The new plane border color |
setPlaneBorderThickness(float planeBorderThickness)
Sets the thickness of axis plane border
Declaration
public abstract void setPlaneBorderThickness(float planeBorderThickness)
Parameters
Type | Name | Description |
---|---|---|
float | planeBorderThickness | The new thickness of plane border |
setPositiveSideClipping(AxisSideClipping positiveSideClipping)
Sets the clipping for positive axis side
Declaration
public abstract void setPositiveSideClipping(AxisSideClipping positiveSideClipping)
Parameters
Type | Name | Description |
---|---|---|
AxisSideClipping | positiveSideClipping | The new positive side clipping mode |
setTextColor(int textColor)
Sets the color of text used by axis
Declaration
public abstract void setTextColor(int textColor)
Parameters
Type | Name | Description |
---|---|---|
int | textColor | The new text color |
setTextFont(String textFont)
Sets font used by axis to draw text
Declaration
public abstract void setTextFont(String textFont)
Parameters
Type | Name | Description |
---|---|---|
String | textFont | The new text font |
setTextSize(float textSize)
Sets the size of text used by axis
Declaration
public abstract void setTextSize(float textSize)
Parameters
Type | Name | Description |
---|---|---|
float | textSize | The new text size |
setTickLabelAlignment(TextAlignment3D tickLabelAlignment)
Sets the TextAlignment of tick labels for the axis drawn in the 3D Viewport
Declaration
public abstract void setTickLabelAlignment(TextAlignment3D tickLabelAlignment)
Parameters
Type | Name | Description |
---|---|---|
TextAlignment3D | tickLabelAlignment | The new tick label alignment |
setTickLabelOffset(float tickLabelOffset)
Sets the offset applied to tick labels drawn by this axis
Declaration
public abstract void setTickLabelOffset(float tickLabelOffset)
Parameters
Type | Name | Description |
---|---|---|
float | tickLabelOffset | The new offset value |
updateCore()
Performs core update of axis (e.g. updates ILabelProvider, ITickProvider, ITickCoordinatesProvider and other providers which are used by axis )
Declaration
public abstract void updateCore()