Class AxisCollection
Contains a collection of IAxis and allows getting of axis by Id
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class AxisCollection extends ObservableCollection<IAxis>
Constructors
AxisCollection()
Initializes a new instance of AxisCollection class
Declaration
public AxisCollection()
AxisCollection(Collection<? extends IAxis> collection)
Initializes a new instance of AxisCollection class
Declaration
public AxisCollection(Collection<? extends IAxis> collection)
Parameters
Type | Name | Description |
---|---|---|
Collection<? extends com.scichart.charting.visuals.axes.IAxis> | collection | The collections with items to add |
Methods
getAxisById(String id)
Gets the axis specified by id if it exists, otherwise returns null
Declaration
public IAxis getAxisById(String id)
Parameters
Type | Name | Description |
---|---|---|
String | id | The axis id |
Returns
Type | Description |
---|---|
IAxis | The axis with specified id if it exists, otherwise returns null |
getAxisById(String id, boolean assertAxisExists)
Gets the axis specified by id if it exists, otherwise returns null
Declaration
public IAxis getAxisById(String id, boolean assertAxisExists)
Parameters
Type | Name | Description |
---|---|---|
String | id | The axis id |
boolean | assertAxisExists | If set to true assert and throw if the axis does not exist |
Returns
Type | Description |
---|---|
IAxis | The axis with specified id if it exists, otherwise returns null |
getDefault()
Gets the default axis, which is equal to the axis with the AxisBase#DEFAULT_AXIS_ID, else null
Declaration
public final IAxis getDefault()
Returns
Type | Description |
---|---|
IAxis | The default axis if it exists, otherwise returns null |
getPrimaryAxis()
Gets the primary axis in the collection. This is the first axis that has IAxis#getIsPrimaryAxis() set to true, or null if none exists.
Declaration
protected final IAxis getPrimaryAxis()
Returns
Type | Description |
---|---|
IAxis | The primary axis if it exist, otherwise returns null |
hasPrimaryAxis()
Gets the value indicating whether this collection has primary axis
Declaration
protected final boolean hasPrimaryAxis()
Returns
Type | Description |
---|---|
boolean | True if any of the Axes in the collection have IAxis#getIsPrimaryAxis() set to true |