Interface Axis
- All Superinterfaces:
org.eclipse.emf.ecore.EObject
,IChartObject
,org.eclipse.emf.common.notify.Notifier
- All Known Implementing Classes:
AxisImpl
A representation of the model object
'Axis'.
This type defines the basic elements that are
expected in any axis. An axis refers to a line along the X, Y, or Z
co-ordinate system used in the plot. It provides a point of reference for the
various values plotted in each direction. This class can further be extended
for special axis types.
The following features are supported:
Type
Title
Sub Title
Title Position
Associated Axes
Ancillary Axes
Series Definitions
Gap Width
Orientation
Line Attributes
Label
Format Specifier
Label Position
Staggered
Interval
Marker Lines
Marker Ranges
Triggers
Major Grid
Minor Grid
Scale
Origin
Primary Axis
Category Axis
Percent
Label Within Axes
Aligned
Side By Side
Cursor
Label Span
Axis Percent
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.emf.common.util.EList<Axis>
Returns the value of the 'Ancillary Axes' containment reference list.org.eclipse.emf.common.util.EList<Axis>
Returns the value of the 'Associated Axes' containment reference list.int
Returns the value of the 'Axis Percent' attribute.Returns the value of the 'Cursor' containment reference.Returns the value of the 'Format Specifier' containment reference.double
Returns the value of the 'Gap Width' attribute.int
Returns the value of the 'Interval' attribute.getLabel()
Returns the value of the 'Label' containment reference.Returns the value of the 'Label Position' attribute.double
Returns the value of the 'Label Span' attribute.Returns the value of the 'Line Attributes' containment reference.Returns the value of the 'Major Grid' containment reference.org.eclipse.emf.common.util.EList<MarkerLine>
Returns the value of the 'Marker Lines' containment reference list.org.eclipse.emf.common.util.EList<MarkerRange>
Returns the value of the 'Marker Ranges' containment reference list.Returns the value of the 'Minor Grid' containment reference.Returns the value of the 'Orientation' attribute.Returns the value of the 'Origin' containment reference.Series[]
getScale()
Returns the value of the 'Scale' containment reference.org.eclipse.emf.common.util.EList<SeriesDefinition>
Returns the value of the 'Series Definitions' containment reference list.Returns the value of the 'Sub Title' containment reference.getTitle()
Returns the value of the 'Title' containment reference.Returns the value of the 'Title Position' attribute.org.eclipse.emf.common.util.EList<Trigger>
Returns the value of the 'Triggers' containment reference list.getType()
Returns the value of the 'Type' attribute.boolean
Returns the value of the 'Aligned' attribute.boolean
Returns the value of the 'Category Axis' attribute.boolean
Returns the value of the 'Label Within Axes' attribute.boolean
Returns the value of the 'Percent' attribute.boolean
Returns the value of the 'Primary Axis' attribute.boolean
Returns whether the value of the 'Aligned
' attribute is set.boolean
Returns whether the value of the 'Axis Percent
' attribute is set.boolean
Returns whether the value of the 'Category Axis
' attribute is set.boolean
Returns whether the value of the 'Gap Width
' attribute is set.boolean
Returns whether the value of the 'Interval
' attribute is set.boolean
Returns whether the value of the 'Label Position
' attribute is set.boolean
Returns whether the value of the 'Label Span
' attribute is set.boolean
Returns whether the value of the 'Label Within Axes
' attribute is set.boolean
Returns whether the value of the 'Orientation
' attribute is set.boolean
Returns whether the value of the 'Percent
' attribute is set.boolean
Returns whether the value of the 'Primary Axis
' attribute is set.boolean
Returns whether the value of the 'Side By Side
' attribute is set.boolean
Returns whether the value of the 'Staggered
' attribute is set.boolean
Returns whether the value of the 'Title Position
' attribute is set.boolean
Returns whether the value of the 'Type
' attribute is set.boolean
Returns the value of the 'Side By Side' attribute.boolean
Returns the value of the 'Staggered' attribute.void
setAligned
(boolean value) Sets the value of the 'Aligned
' attribute.void
setAxisPercent
(int value) Sets the value of the 'Axis Percent
' attribute.void
setCategoryAxis
(boolean value) Sets the value of the 'Category Axis
' attribute.void
Sets the value of the 'Cursor
' containment reference.void
Sets the value of the 'Format Specifier
' containment reference.void
setGapWidth
(double value) Sets the value of the 'Gap Width
' attribute.void
setInterval
(int value) Sets the value of the 'Interval
' attribute.void
Sets the value of the 'Label
' containment reference.void
setLabelPosition
(Position value) Sets the value of the 'Label Position
' attribute.void
setLabelSpan
(double value) Sets the value of the 'Label Span
' attribute.void
setLabelWithinAxes
(boolean value) Sets the value of the 'Label Within Axes
' attribute.void
setLineAttributes
(LineAttributes value) Sets the value of the 'Line Attributes
' containment reference.void
setMajorGrid
(Grid value) Sets the value of the 'Major Grid
' containment reference.void
setMinorGrid
(Grid value) Sets the value of the 'Minor Grid
' containment reference.void
setOrientation
(Orientation value) Sets the value of the 'Orientation
' attribute.void
setOrigin
(AxisOrigin value) Sets the value of the 'Origin
' containment reference.void
setPercent
(boolean value) Sets the value of the 'Percent
' attribute.void
setPrimaryAxis
(boolean value) Sets the value of the 'Primary Axis
' attribute.void
Sets the value of the 'Scale
' containment reference.void
setSideBySide
(boolean value) Sets the value of the 'Side By Side
' attribute.void
setStaggered
(boolean value) Sets the value of the 'Staggered
' attribute.void
setSubTitle
(Label value) Sets the value of the 'Sub Title
' containment reference.void
Sets the value of the 'Title
' containment reference.void
setTitlePosition
(Position value) Sets the value of the 'Title Position
' attribute.void
Sets the value of the 'Type
' attribute.void
Unsets the value of the 'Aligned
' attribute.void
Unsets the value of the 'Axis Percent
' attribute.void
Unsets the value of the 'Category Axis
' attribute.void
Unsets the value of the 'Gap Width
' attribute.void
Unsets the value of the 'Interval
' attribute.void
Unsets the value of the 'Label Position
' attribute.void
Unsets the value of the 'Label Span
' attribute.void
Unsets the value of the 'Label Within Axes
' attribute.void
Unsets the value of the 'Orientation
' attribute.void
Unsets the value of the 'Percent
' attribute.void
Unsets the value of the 'Primary Axis
' attribute.void
Unsets the value of the 'Side By Side
' attribute.void
Unsets the value of the 'Staggered
' attribute.void
Unsets the value of the 'Title Position
' attribute.void
Unsets the value of the 'Type
' attribute.Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
-
Field Details
-
BASE
static final int BASE- See Also:
-
ORTHOGONAL
static final int ORTHOGONAL- See Also:
-
ANCILLARY_BASE
static final int ANCILLARY_BASE- See Also:
-
-
Method Details
-
getType
AxisType getType()Returns the value of the 'Type' attribute. The default value is"Linear"
. The literals are from the enumerationAxisType
. Returns the type of the axis. The type specifies the data that can be used by associated series. The expected types with the data type expected is as follows:- Linear
- Double
- Logarithmic
- Double
- Date/Time
- Calendar
- Text
- String
- Returns:
- the value of the 'Type' attribute.
- See Also:
-
setType
Sets the value of the 'Type
' attribute.- Parameters:
value
- the new value of the 'Type' attribute.- See Also:
-
unsetType
void unsetType()Unsets the value of the 'Type
' attribute.- See Also:
-
isSetType
boolean isSetType()Returns whether the value of the 'Type
' attribute is set.- Returns:
- whether the value of the 'Type' attribute is set.
- See Also:
-
getTitle
Label getTitle()Returns the value of the 'Title' containment reference. Gets the axis title. This is the element title.- Returns:
- the value of the 'Title' containment reference.
- See Also:
-
setTitle
Sets the value of the 'Title
' containment reference.- Parameters:
value
- the new value of the 'Title' containment reference.- See Also:
-
getSubTitle
Label getSubTitle()Returns the value of the 'Sub Title' containment reference. This is the element subtitle.- Returns:
- the value of the 'Sub Title' containment reference.
- See Also:
-
setSubTitle
Sets the value of the 'Sub Title
' containment reference.- Parameters:
value
- the new value of the 'Sub Title' containment reference.- See Also:
-
getTitlePosition
Position getTitlePosition()Returns the value of the 'Title Position' attribute. The default value is"Above"
. The literals are from the enumerationPosition
. Specifies where the title for the axis should be displayed.- Returns:
- the value of the 'Title Position' attribute.
- See Also:
-
setTitlePosition
Sets the value of the 'Title Position
' attribute.- Parameters:
value
- the new value of the 'Title Position' attribute.- See Also:
-
unsetTitlePosition
void unsetTitlePosition()Unsets the value of the 'Title Position
' attribute. -
isSetTitlePosition
boolean isSetTitlePosition()Returns whether the value of the 'Title Position
' attribute is set.- Returns:
- whether the value of the 'Title Position' attribute is set.
- See Also:
-
getAssociatedAxes
org.eclipse.emf.common.util.EList<Axis> getAssociatedAxes()Returns the value of the 'Associated Axes' containment reference list. The list contents are of typeAxis
. Gets the list of orthogonal axes associated with this axis. (This call only makes sence when made on Base axes.) Holds the value orthogonal axes associated with this axis.- Returns:
- the value of the 'Associated Axes' containment reference list.
- See Also:
-
getAncillaryAxes
org.eclipse.emf.common.util.EList<Axis> getAncillaryAxes()Returns the value of the 'Ancillary Axes' containment reference list. The list contents are of typeAxis
. Holds the value ancillary base axes associated with this axis.- Returns:
- the value of the 'Ancillary Axes' containment reference list.
- See Also:
-
getSeriesDefinitions
org.eclipse.emf.common.util.EList<SeriesDefinition> getSeriesDefinitions()Returns the value of the 'Series Definitions' containment reference list. The list contents are of typeSeriesDefinition
. Defines the source of the series.- Returns:
- the value of the 'Series Definitions' containment reference list.
- See Also:
-
getGapWidth
double getGapWidth()Returns the value of the 'Gap Width' attribute. Holds the spacing between the first (or last) series marker and the edge of the unit on the axis. This is specified as a percentage.- Returns:
- the value of the 'Gap Width' attribute.
- See Also:
-
setGapWidth
void setGapWidth(double value) Sets the value of the 'Gap Width
' attribute.- Parameters:
value
- the new value of the 'Gap Width' attribute.- See Also:
-
unsetGapWidth
void unsetGapWidth()Unsets the value of the 'Gap Width
' attribute.- See Also:
-
isSetGapWidth
boolean isSetGapWidth()Returns whether the value of the 'Gap Width
' attribute is set.- Returns:
- whether the value of the 'Gap Width' attribute is set.
- See Also:
-
getOrientation
Orientation getOrientation()Returns the value of the 'Orientation' attribute. The default value is"Horizontal"
. The literals are from the enumerationOrientation
. Gets the orientation of the axis. This will be affected by the Orientation for the chart as a whole. Specifies the orientation of the Axis.- Returns:
- the value of the 'Orientation' attribute.
- See Also:
-
setOrientation
Sets the value of the 'Orientation
' attribute.- Parameters:
value
- the new value of the 'Orientation' attribute.- See Also:
-
unsetOrientation
void unsetOrientation()Unsets the value of the 'Orientation
' attribute. -
isSetOrientation
boolean isSetOrientation()Returns whether the value of the 'Orientation
' attribute is set.- Returns:
- whether the value of the 'Orientation' attribute is set.
- See Also:
-
getLineAttributes
LineAttributes getLineAttributes()Returns the value of the 'Line Attributes' containment reference. Specifies the formatting information for the axis line.- Returns:
- the value of the 'Line Attributes' containment reference.
- See Also:
-
setLineAttributes
Sets the value of the 'Line Attributes
' containment reference.- Parameters:
value
- the new value of the 'Line Attributes' containment reference.- See Also:
-
getLabel
Label getLabel()Returns the value of the 'Label' containment reference. Returns a Label instance that defines the properties to be used for all axis labels. A label instance to hold attributes for axis labels.- Returns:
- the value of the 'Label' containment reference.
- See Also:
-
setLabel
Sets the value of the 'Label
' containment reference.- Parameters:
value
- the new value of the 'Label' containment reference.- See Also:
-
getFormatSpecifier
FormatSpecifier getFormatSpecifier()Returns the value of the 'Format Specifier' containment reference. Specifies the formatting for axis labels.- Returns:
- the value of the 'Format Specifier' containment reference.
- See Also:
-
setFormatSpecifier
Sets the value of the 'Format Specifier
' containment reference.- Parameters:
value
- the new value of the 'Format Specifier' containment reference.- See Also:
-
getLabelPosition
Position getLabelPosition()Returns the value of the 'Label Position' attribute. The default value is"Above"
. The literals are from the enumerationPosition
. Specifies where the labels for the axis should be displayed.- Returns:
- the value of the 'Label Position' attribute.
- See Also:
-
setLabelPosition
Sets the value of the 'Label Position
' attribute.- Parameters:
value
- the new value of the 'Label Position' attribute.- See Also:
-
unsetLabelPosition
void unsetLabelPosition()Unsets the value of the 'Label Position
' attribute. -
isSetLabelPosition
boolean isSetLabelPosition()Returns whether the value of the 'Label Position
' attribute is set.- Returns:
- whether the value of the 'Label Position' attribute is set.
- See Also:
-
isStaggered
boolean isStaggered()Returns the value of the 'Staggered' attribute. Specifies the position to be used for the labels. (Staggered/Straight)- Returns:
- the value of the 'Staggered' attribute.
- See Also:
-
setStaggered
void setStaggered(boolean value) Sets the value of the 'Staggered
' attribute.- Parameters:
value
- the new value of the 'Staggered' attribute.- See Also:
-
unsetStaggered
void unsetStaggered()Unsets the value of the 'Staggered
' attribute. -
isSetStaggered
boolean isSetStaggered()Returns whether the value of the 'Staggered
' attribute is set.- Returns:
- whether the value of the 'Staggered' attribute is set.
- See Also:
-
getInterval
int getInterval()Returns the value of the 'Interval' attribute. The default value is"1"
. Specifies the showing interval for the labels.- Returns:
- the value of the 'Interval' attribute.
- See Also:
-
setInterval
void setInterval(int value) Sets the value of the 'Interval
' attribute.- Parameters:
value
- the new value of the 'Interval' attribute.- See Also:
-
unsetInterval
void unsetInterval()Unsets the value of the 'Interval
' attribute.- See Also:
-
isSetInterval
boolean isSetInterval()Returns whether the value of the 'Interval
' attribute is set.- Returns:
- whether the value of the 'Interval' attribute is set.
- See Also:
-
getMarkerLines
org.eclipse.emf.common.util.EList<MarkerLine> getMarkerLines()Returns the value of the 'Marker Lines' containment reference list. The list contents are of typeMarkerLine
. Defines a set of markers for positions on the axis scale displayed as lines across the plot at those locations.- Returns:
- the value of the 'Marker Lines' containment reference list.
- See Also:
-
getMarkerRanges
org.eclipse.emf.common.util.EList<MarkerRange> getMarkerRanges()Returns the value of the 'Marker Ranges' containment reference list. The list contents are of typeMarkerRange
. Defines a set of marker areas for a range of values on the axis displayed as filled rectangles extending across the plot between the start and end positions.- Returns:
- the value of the 'Marker Ranges' containment reference list.
- See Also:
-
getTriggers
org.eclipse.emf.common.util.EList<Trigger> getTriggers()Returns the value of the 'Triggers' containment reference list. The list contents are of typeTrigger
. Holds the triggers for the axis.- Returns:
- the value of the 'Triggers' containment reference list.
- See Also:
-
getMajorGrid
Grid getMajorGrid()Returns the value of the 'Major Grid' containment reference. Defines the major grid associated with the axis.- Returns:
- the value of the 'Major Grid' containment reference.
- See Also:
-
setMajorGrid
Sets the value of the 'Major Grid
' containment reference.- Parameters:
value
- the new value of the 'Major Grid' containment reference.- See Also:
-
getMinorGrid
Grid getMinorGrid()Returns the value of the 'Minor Grid' containment reference. Defines the minor grid associated with the axis.- Returns:
- the value of the 'Minor Grid' containment reference.
- See Also:
-
setMinorGrid
Sets the value of the 'Minor Grid
' containment reference.- Parameters:
value
- the new value of the 'Minor Grid' containment reference.- See Also:
-
getScale
Scale getScale()Returns the value of the 'Scale' containment reference. Defines the scale for the axis.- Returns:
- the value of the 'Scale' containment reference.
- See Also:
-
setScale
Sets the value of the 'Scale
' containment reference.- Parameters:
value
- the new value of the 'Scale' containment reference.- See Also:
-
getOrigin
AxisOrigin getOrigin()Returns the value of the 'Origin' containment reference. Specifies the location on the axis that should co-incide with the origin of the chart.- Returns:
- the value of the 'Origin' containment reference.
- See Also:
-
setOrigin
Sets the value of the 'Origin
' containment reference.- Parameters:
value
- the new value of the 'Origin' containment reference.- See Also:
-
isPrimaryAxis
boolean isPrimaryAxis()Returns the value of the 'Primary Axis' attribute. Specifies whether or not this is a primary axis.- Returns:
- the value of the 'Primary Axis' attribute.
- See Also:
-
setPrimaryAxis
void setPrimaryAxis(boolean value) Sets the value of the 'Primary Axis
' attribute.- Parameters:
value
- the new value of the 'Primary Axis' attribute.- See Also:
-
unsetPrimaryAxis
void unsetPrimaryAxis()Unsets the value of the 'Primary Axis
' attribute. -
isSetPrimaryAxis
boolean isSetPrimaryAxis()Returns whether the value of the 'Primary Axis
' attribute is set.- Returns:
- whether the value of the 'Primary Axis' attribute is set.
- See Also:
-
isCategoryAxis
boolean isCategoryAxis()Returns the value of the 'Category Axis' attribute. Specifies whether or not this is a category axis.- Returns:
- the value of the 'Category Axis' attribute.
- See Also:
-
setCategoryAxis
void setCategoryAxis(boolean value) Sets the value of the 'Category Axis
' attribute.- Parameters:
value
- the new value of the 'Category Axis' attribute.- See Also:
-
unsetCategoryAxis
void unsetCategoryAxis()Unsets the value of the 'Category Axis
' attribute. -
isSetCategoryAxis
boolean isSetCategoryAxis()Returns whether the value of the 'Category Axis
' attribute is set.- Returns:
- whether the value of the 'Category Axis' attribute is set.
- See Also:
-
isPercent
boolean isPercent()Returns the value of the 'Percent' attribute. Specifies whether or not this is a percentage axis.- Returns:
- the value of the 'Percent' attribute.
- See Also:
-
setPercent
void setPercent(boolean value) Sets the value of the 'Percent
' attribute.- Parameters:
value
- the new value of the 'Percent' attribute.- See Also:
-
unsetPercent
void unsetPercent()Unsets the value of the 'Percent
' attribute.- See Also:
-
isSetPercent
boolean isSetPercent()Returns whether the value of the 'Percent
' attribute is set.- Returns:
- whether the value of the 'Percent' attribute is set.
- See Also:
-
isLabelWithinAxes
boolean isLabelWithinAxes()Returns the value of the 'Label Within Axes' attribute. The default value is"false"
. Specifies whether axis labels are within axes, i.e. inside the axis delimited area.- Returns:
- the value of the 'Label Within Axes' attribute.
- See Also:
-
setLabelWithinAxes
void setLabelWithinAxes(boolean value) Sets the value of the 'Label Within Axes
' attribute.- Parameters:
value
- the new value of the 'Label Within Axes' attribute.- See Also:
-
unsetLabelWithinAxes
void unsetLabelWithinAxes()Unsets the value of the 'Label Within Axes
' attribute. -
isSetLabelWithinAxes
boolean isSetLabelWithinAxes()Returns whether the value of the 'Label Within Axes
' attribute is set.- Returns:
- whether the value of the 'Label Within Axes' attribute is set.
- See Also:
-
isAligned
boolean isAligned()Returns the value of the 'Aligned' attribute. The default value is"false"
. Specifies whether the zero point of this axis is to be aligned with other axes whose "Aligned" is true.- Returns:
- the value of the 'Aligned' attribute.
- See Also:
-
setAligned
void setAligned(boolean value) Sets the value of the 'Aligned
' attribute.- Parameters:
value
- the new value of the 'Aligned' attribute.- See Also:
-
unsetAligned
void unsetAligned()Unsets the value of the 'Aligned
' attribute.- See Also:
-
isSetAligned
boolean isSetAligned()Returns whether the value of the 'Aligned
' attribute is set.- Returns:
- whether the value of the 'Aligned' attribute is set.
- See Also:
-
isSideBySide
boolean isSideBySide()Returns the value of the 'Side By Side' attribute. The default value is"false"
. Specifies whether the data points of this axis is to be placed side by side instead of overlayed with those of other axes whose "SideBySide" is true.- Returns:
- the value of the 'Side By Side' attribute.
- See Also:
-
setSideBySide
void setSideBySide(boolean value) Sets the value of the 'Side By Side
' attribute.- Parameters:
value
- the new value of the 'Side By Side' attribute.- See Also:
-
unsetSideBySide
void unsetSideBySide()Unsets the value of the 'Side By Side
' attribute. -
isSetSideBySide
boolean isSetSideBySide()Returns whether the value of the 'Side By Side
' attribute is set.- Returns:
- whether the value of the 'Side By Side' attribute is set.
- See Also:
-
getCursor
Cursor getCursor()Returns the value of the 'Cursor' containment reference. The element represents a cursor for axis area.- Returns:
- the value of the 'Cursor' containment reference.
- See Also:
-
setCursor
Sets the value of the 'Cursor
' containment reference.- Parameters:
value
- the new value of the 'Cursor' containment reference.- See Also:
-
getLabelSpan
double getLabelSpan()Returns the value of the 'Label Span' attribute. Give the user a way to customize a fixed thickness of axis label. Span means width for vertical axis, and height for horizontal axis. By default, this value is unset.- Returns:
- the value of the 'Label Span' attribute.
- See Also:
-
setLabelSpan
void setLabelSpan(double value) Sets the value of the 'Label Span
' attribute.- Parameters:
value
- the new value of the 'Label Span' attribute.- See Also:
-
unsetLabelSpan
void unsetLabelSpan()Unsets the value of the 'Label Span
' attribute. -
isSetLabelSpan
boolean isSetLabelSpan()Returns whether the value of the 'Label Span
' attribute is set.- Returns:
- whether the value of the 'Label Span' attribute is set.
- See Also:
-
getAxisPercent
int getAxisPercent()Returns the value of the 'Axis Percent' attribute. This field indicates this axis will use what percent size of chart plot height if the AxesStudyLayout of ChartWithAxes is true. The value of this field is just a number, not a percent value. The actual percent value will be computed by dividing total numbers of all axes.- Returns:
- the value of the 'Axis Percent' attribute.
- See Also:
-
setAxisPercent
void setAxisPercent(int value) Sets the value of the 'Axis Percent
' attribute.- Parameters:
value
- the new value of the 'Axis Percent' attribute.- See Also:
-
unsetAxisPercent
void unsetAxisPercent()Unsets the value of the 'Axis Percent
' attribute. -
isSetAxisPercent
boolean isSetAxisPercent()Returns whether the value of the 'Axis Percent
' attribute is set.- Returns:
- whether the value of the 'Axis Percent' attribute is set.
- See Also:
-
getRuntimeSeries
Series[] getRuntimeSeries()- Returns:
- All runtime series associated with a particular axis
-
copyInstance
Axis copyInstance()- Specified by:
copyInstance
in interfaceIChartObject
-