|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Axis
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
ComponentPackage.getAxis()
Field Summary | |
---|---|
static int |
ANCILLARY_BASE
|
static int |
BASE
|
static int |
ORTHOGONAL
|
Method Summary | |
---|---|
Axis |
copyInstance()
|
org.eclipse.emf.common.util.EList<Axis> |
getAncillaryAxes()
Returns the value of the 'Ancillary Axes' containment reference list. |
org.eclipse.emf.common.util.EList<Axis> |
getAssociatedAxes()
Returns the value of the 'Associated Axes' containment reference list. |
int |
getAxisPercent()
Returns the value of the 'Axis Percent' attribute. |
Cursor |
getCursor()
Returns the value of the 'Cursor' containment reference. |
FormatSpecifier |
getFormatSpecifier()
Returns the value of the 'Format Specifier' containment reference. |
double |
getGapWidth()
Returns the value of the 'Gap Width' attribute. |
int |
getInterval()
Returns the value of the 'Interval' attribute. |
Label |
getLabel()
Returns the value of the 'Label' containment reference. |
Position |
getLabelPosition()
Returns the value of the 'Label Position' attribute. |
double |
getLabelSpan()
Returns the value of the 'Label Span' attribute. |
LineAttributes |
getLineAttributes()
Returns the value of the 'Line Attributes' containment reference. |
Grid |
getMajorGrid()
Returns the value of the 'Major Grid' containment reference. |
org.eclipse.emf.common.util.EList<MarkerLine> |
getMarkerLines()
Returns the value of the 'Marker Lines' containment reference list. |
org.eclipse.emf.common.util.EList<MarkerRange> |
getMarkerRanges()
Returns the value of the 'Marker Ranges' containment reference list. |
Grid |
getMinorGrid()
Returns the value of the 'Minor Grid' containment reference. |
Orientation |
getOrientation()
Returns the value of the 'Orientation' attribute. |
AxisOrigin |
getOrigin()
Returns the value of the 'Origin' containment reference. |
Series[] |
getRuntimeSeries()
|
Scale |
getScale()
Returns the value of the 'Scale' containment reference. |
org.eclipse.emf.common.util.EList<SeriesDefinition> |
getSeriesDefinitions()
Returns the value of the 'Series Definitions' containment reference list. |
Label |
getSubTitle()
Returns the value of the 'Sub Title' containment reference. |
Label |
getTitle()
Returns the value of the 'Title' containment reference. |
Position |
getTitlePosition()
Returns the value of the 'Title Position' attribute. |
org.eclipse.emf.common.util.EList<Trigger> |
getTriggers()
Returns the value of the 'Triggers' containment reference list. |
AxisType |
getType()
Returns the value of the 'Type' attribute. |
boolean |
isAligned()
Returns the value of the 'Aligned' attribute. |
boolean |
isCategoryAxis()
Returns the value of the 'Category Axis' attribute. |
boolean |
isLabelWithinAxes()
Returns the value of the 'Label Within Axes' attribute. |
boolean |
isPercent()
Returns the value of the 'Percent' attribute. |
boolean |
isPrimaryAxis()
Returns the value of the 'Primary Axis' attribute. |
boolean |
isSetAligned()
Returns whether the value of the ' Aligned ' attribute is set. |
boolean |
isSetAxisPercent()
Returns whether the value of the ' Axis Percent ' attribute is set. |
boolean |
isSetCategoryAxis()
Returns whether the value of the ' Category Axis ' attribute is set. |
boolean |
isSetGapWidth()
Returns whether the value of the ' Gap Width ' attribute is set. |
boolean |
isSetInterval()
Returns whether the value of the ' Interval ' attribute is set. |
boolean |
isSetLabelPosition()
Returns whether the value of the ' Label Position ' attribute is set. |
boolean |
isSetLabelSpan()
Returns whether the value of the ' Label Span ' attribute is set. |
boolean |
isSetLabelWithinAxes()
Returns whether the value of the ' Label Within Axes ' attribute is set. |
boolean |
isSetOrientation()
Returns whether the value of the ' Orientation ' attribute is set. |
boolean |
isSetPercent()
Returns whether the value of the ' Percent ' attribute is set. |
boolean |
isSetPrimaryAxis()
Returns whether the value of the ' Primary Axis ' attribute is set. |
boolean |
isSetSideBySide()
Returns whether the value of the ' Side By Side ' attribute is set. |
boolean |
isSetStaggered()
Returns whether the value of the ' Staggered ' attribute is set. |
boolean |
isSetTitlePosition()
Returns whether the value of the ' Title Position ' attribute is set. |
boolean |
isSetType()
Returns whether the value of the ' Type ' attribute is set. |
boolean |
isSideBySide()
Returns the value of the 'Side By Side' attribute. |
boolean |
isStaggered()
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 |
setCursor(Cursor value)
Sets the value of the ' Cursor ' containment reference. |
void |
setFormatSpecifier(FormatSpecifier value)
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 |
setLabel(Label value)
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 |
setScale(Scale value)
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 |
setTitle(Label value)
Sets the value of the ' Title ' containment reference. |
void |
setTitlePosition(Position value)
Sets the value of the ' Title Position ' attribute. |
void |
setType(AxisType value)
Sets the value of the ' Type ' attribute. |
void |
unsetAligned()
Unsets the value of the ' Aligned ' attribute. |
void |
unsetAxisPercent()
Unsets the value of the ' Axis Percent ' attribute. |
void |
unsetCategoryAxis()
Unsets the value of the ' Category Axis ' attribute. |
void |
unsetGapWidth()
Unsets the value of the ' Gap Width ' attribute. |
void |
unsetInterval()
Unsets the value of the ' Interval ' attribute. |
void |
unsetLabelPosition()
Unsets the value of the ' Label Position ' attribute. |
void |
unsetLabelSpan()
Unsets the value of the ' Label Span ' attribute. |
void |
unsetLabelWithinAxes()
Unsets the value of the ' Label Within Axes ' attribute. |
void |
unsetOrientation()
Unsets the value of the ' Orientation ' attribute. |
void |
unsetPercent()
Unsets the value of the ' Percent ' attribute. |
void |
unsetPrimaryAxis()
Unsets the value of the ' Primary Axis ' attribute. |
void |
unsetSideBySide()
Unsets the value of the ' Side By Side ' attribute. |
void |
unsetStaggered()
Unsets the value of the ' Staggered ' attribute. |
void |
unsetTitlePosition()
Unsets the value of the ' Title Position ' attribute. |
void |
unsetType()
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 Detail |
---|
static final int BASE
static final int ORTHOGONAL
static final int ANCILLARY_BASE
Method Detail |
---|
AxisType getType()
"Linear"
.
The literals are from the enumeration AxisType
. 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:
AxisType
,
isSetType()
,
unsetType()
,
setType(AxisType)
,
ComponentPackage.getAxis_Type()
void setType(AxisType value)
Type
' attribute.
value
- the new value of the 'Type' attribute.AxisType
,
isSetType()
,
unsetType()
,
getType()
void unsetType()
Type
' attribute.
isSetType()
,
getType()
,
setType(AxisType)
boolean isSetType()
Type
' attribute is set.
unsetType()
,
getType()
,
setType(AxisType)
Label getTitle()
setTitle(Label)
,
ComponentPackage.getAxis_Title()
void setTitle(Label value)
Title
' containment reference.
value
- the new value of the 'Title' containment reference.getTitle()
Label getSubTitle()
setSubTitle(Label)
,
ComponentPackage.getAxis_SubTitle()
void setSubTitle(Label value)
Sub Title
' containment reference.
value
- the new value of the 'Sub Title' containment reference.getSubTitle()
Position getTitlePosition()
"Above"
. The literals are from the enumeration
Position
.
Specifies where the title for the axis should be displayed.
Position
,
isSetTitlePosition()
,
unsetTitlePosition()
,
setTitlePosition(Position)
,
ComponentPackage.getAxis_TitlePosition()
void setTitlePosition(Position value)
Title Position
' attribute.
value
- the new value of the 'Title Position' attribute.Position
,
isSetTitlePosition()
,
unsetTitlePosition()
,
getTitlePosition()
void unsetTitlePosition()
Title Position
' attribute.
isSetTitlePosition()
,
getTitlePosition()
,
setTitlePosition(Position)
boolean isSetTitlePosition()
Title Position
' attribute is set.
unsetTitlePosition()
,
getTitlePosition()
,
setTitlePosition(Position)
org.eclipse.emf.common.util.EList<Axis> getAssociatedAxes()
Axis
. 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.
ComponentPackage.getAxis_AssociatedAxes()
org.eclipse.emf.common.util.EList<Axis> getAncillaryAxes()
Axis
.
Holds the value ancillary base axes associated
with this axis.
ComponentPackage.getAxis_AncillaryAxes()
org.eclipse.emf.common.util.EList<SeriesDefinition> getSeriesDefinitions()
SeriesDefinition
.
Defines the source of the series.
ComponentPackage.getAxis_SeriesDefinitions()
double getGapWidth()
isSetGapWidth()
,
unsetGapWidth()
,
setGapWidth(double)
,
ComponentPackage.getAxis_GapWidth()
void setGapWidth(double value)
Gap Width
' attribute.
value
- the new value of the 'Gap Width' attribute.isSetGapWidth()
,
unsetGapWidth()
,
getGapWidth()
void unsetGapWidth()
Gap Width
' attribute.
isSetGapWidth()
,
getGapWidth()
,
setGapWidth(double)
boolean isSetGapWidth()
Gap Width
' attribute is set.
unsetGapWidth()
,
getGapWidth()
,
setGapWidth(double)
Orientation getOrientation()
"Horizontal"
. The literals are from the enumeration
Orientation
. 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.
Orientation
,
isSetOrientation()
,
unsetOrientation()
,
setOrientation(Orientation)
,
ComponentPackage.getAxis_Orientation()
void setOrientation(Orientation value)
Orientation
' attribute.
value
- the new value of the 'Orientation' attribute.Orientation
,
isSetOrientation()
,
unsetOrientation()
,
getOrientation()
void unsetOrientation()
Orientation
' attribute.
isSetOrientation()
,
getOrientation()
,
setOrientation(Orientation)
boolean isSetOrientation()
Orientation
' attribute is set.
unsetOrientation()
,
getOrientation()
,
setOrientation(Orientation)
LineAttributes getLineAttributes()
setLineAttributes(LineAttributes)
,
ComponentPackage.getAxis_LineAttributes()
void setLineAttributes(LineAttributes value)
Line Attributes
' containment reference.
value
- the new value of the 'Line Attributes' containment reference.getLineAttributes()
Label getLabel()
setLabel(Label)
,
ComponentPackage.getAxis_Label()
void setLabel(Label value)
Label
' containment reference.
value
- the new value of the 'Label' containment reference.getLabel()
FormatSpecifier getFormatSpecifier()
setFormatSpecifier(FormatSpecifier)
,
ComponentPackage.getAxis_FormatSpecifier()
void setFormatSpecifier(FormatSpecifier value)
Format Specifier
' containment reference.
value
- the new value of the 'Format Specifier' containment reference.getFormatSpecifier()
Position getLabelPosition()
"Above"
. The literals are from the enumeration
Position
.
Specifies where the labels for the axis should be displayed.
Position
,
isSetLabelPosition()
,
unsetLabelPosition()
,
setLabelPosition(Position)
,
ComponentPackage.getAxis_LabelPosition()
void setLabelPosition(Position value)
Label Position
' attribute.
value
- the new value of the 'Label Position' attribute.Position
,
isSetLabelPosition()
,
unsetLabelPosition()
,
getLabelPosition()
void unsetLabelPosition()
Label Position
' attribute.
isSetLabelPosition()
,
getLabelPosition()
,
setLabelPosition(Position)
boolean isSetLabelPosition()
Label Position
' attribute is set.
unsetLabelPosition()
,
getLabelPosition()
,
setLabelPosition(Position)
boolean isStaggered()
isSetStaggered()
,
unsetStaggered()
,
setStaggered(boolean)
,
ComponentPackage.getAxis_Staggered()
void setStaggered(boolean value)
Staggered
' attribute.
value
- the new value of the 'Staggered' attribute.isSetStaggered()
,
unsetStaggered()
,
isStaggered()
void unsetStaggered()
Staggered
' attribute.
isSetStaggered()
,
isStaggered()
,
setStaggered(boolean)
boolean isSetStaggered()
Staggered
' attribute is set.
unsetStaggered()
,
isStaggered()
,
setStaggered(boolean)
int getInterval()
"1"
.
Specifies the showing interval for the labels.
isSetInterval()
,
unsetInterval()
,
setInterval(int)
,
ComponentPackage.getAxis_Interval()
void setInterval(int value)
Interval
' attribute.
value
- the new value of the 'Interval' attribute.isSetInterval()
,
unsetInterval()
,
getInterval()
void unsetInterval()
Interval
' attribute.
isSetInterval()
,
getInterval()
,
setInterval(int)
boolean isSetInterval()
Interval
' attribute is set.
unsetInterval()
,
getInterval()
,
setInterval(int)
org.eclipse.emf.common.util.EList<MarkerLine> getMarkerLines()
MarkerLine
.
Defines a set of markers for positions on the
axis scale displayed as lines across the plot at
those locations.
ComponentPackage.getAxis_MarkerLines()
org.eclipse.emf.common.util.EList<MarkerRange> getMarkerRanges()
MarkerRange
.
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.
ComponentPackage.getAxis_MarkerRanges()
org.eclipse.emf.common.util.EList<Trigger> getTriggers()
Trigger
.
Holds the triggers for the axis.
ComponentPackage.getAxis_Triggers()
Grid getMajorGrid()
setMajorGrid(Grid)
,
ComponentPackage.getAxis_MajorGrid()
void setMajorGrid(Grid value)
Major Grid
' containment reference.
value
- the new value of the 'Major Grid' containment reference.getMajorGrid()
Grid getMinorGrid()
setMinorGrid(Grid)
,
ComponentPackage.getAxis_MinorGrid()
void setMinorGrid(Grid value)
Minor Grid
' containment reference.
value
- the new value of the 'Minor Grid' containment reference.getMinorGrid()
Scale getScale()
setScale(Scale)
,
ComponentPackage.getAxis_Scale()
void setScale(Scale value)
Scale
' containment reference.
value
- the new value of the 'Scale' containment reference.getScale()
AxisOrigin getOrigin()
setOrigin(AxisOrigin)
,
ComponentPackage.getAxis_Origin()
void setOrigin(AxisOrigin value)
Origin
' containment reference.
value
- the new value of the 'Origin' containment reference.getOrigin()
boolean isPrimaryAxis()
isSetPrimaryAxis()
,
unsetPrimaryAxis()
,
setPrimaryAxis(boolean)
,
ComponentPackage.getAxis_PrimaryAxis()
void setPrimaryAxis(boolean value)
Primary Axis
' attribute.
value
- the new value of the 'Primary Axis' attribute.isSetPrimaryAxis()
,
unsetPrimaryAxis()
,
isPrimaryAxis()
void unsetPrimaryAxis()
Primary Axis
' attribute.
isSetPrimaryAxis()
,
isPrimaryAxis()
,
setPrimaryAxis(boolean)
boolean isSetPrimaryAxis()
Primary Axis
' attribute is set.
unsetPrimaryAxis()
,
isPrimaryAxis()
,
setPrimaryAxis(boolean)
boolean isCategoryAxis()
isSetCategoryAxis()
,
unsetCategoryAxis()
,
setCategoryAxis(boolean)
,
ComponentPackage.getAxis_CategoryAxis()
void setCategoryAxis(boolean value)
Category Axis
' attribute.
value
- the new value of the 'Category Axis' attribute.isSetCategoryAxis()
,
unsetCategoryAxis()
,
isCategoryAxis()
void unsetCategoryAxis()
Category Axis
' attribute.
isSetCategoryAxis()
,
isCategoryAxis()
,
setCategoryAxis(boolean)
boolean isSetCategoryAxis()
Category Axis
' attribute is set.
unsetCategoryAxis()
,
isCategoryAxis()
,
setCategoryAxis(boolean)
boolean isPercent()
isSetPercent()
,
unsetPercent()
,
setPercent(boolean)
,
ComponentPackage.getAxis_Percent()
void setPercent(boolean value)
Percent
' attribute.
value
- the new value of the 'Percent' attribute.isSetPercent()
,
unsetPercent()
,
isPercent()
void unsetPercent()
Percent
' attribute.
isSetPercent()
,
isPercent()
,
setPercent(boolean)
boolean isSetPercent()
Percent
' attribute is set.
unsetPercent()
,
isPercent()
,
setPercent(boolean)
boolean isLabelWithinAxes()
"false"
.
Specifies whether axis labels are within axes,
i.e. inside the axis delimited area.
isSetLabelWithinAxes()
,
unsetLabelWithinAxes()
,
setLabelWithinAxes(boolean)
,
ComponentPackage.getAxis_LabelWithinAxes()
void setLabelWithinAxes(boolean value)
Label Within Axes
' attribute.
value
- the new value of the 'Label Within Axes' attribute.isSetLabelWithinAxes()
,
unsetLabelWithinAxes()
,
isLabelWithinAxes()
void unsetLabelWithinAxes()
Label Within Axes
' attribute.
isSetLabelWithinAxes()
,
isLabelWithinAxes()
,
setLabelWithinAxes(boolean)
boolean isSetLabelWithinAxes()
Label Within Axes
' attribute is set.
unsetLabelWithinAxes()
,
isLabelWithinAxes()
,
setLabelWithinAxes(boolean)
boolean isAligned()
"false"
.
Specifies whether the zero point of this axis is
to be aligned with other axes whose "Aligned" is
true.
isSetAligned()
,
unsetAligned()
,
setAligned(boolean)
,
ComponentPackage.getAxis_Aligned()
void setAligned(boolean value)
Aligned
' attribute.
value
- the new value of the 'Aligned' attribute.isSetAligned()
,
unsetAligned()
,
isAligned()
void unsetAligned()
Aligned
' attribute.
isSetAligned()
,
isAligned()
,
setAligned(boolean)
boolean isSetAligned()
Aligned
' attribute is set.
unsetAligned()
,
isAligned()
,
setAligned(boolean)
boolean isSideBySide()
"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.
isSetSideBySide()
,
unsetSideBySide()
,
setSideBySide(boolean)
,
ComponentPackage.getAxis_SideBySide()
void setSideBySide(boolean value)
Side By Side
' attribute.
value
- the new value of the 'Side By Side' attribute.isSetSideBySide()
,
unsetSideBySide()
,
isSideBySide()
void unsetSideBySide()
Side By Side
' attribute.
isSetSideBySide()
,
isSideBySide()
,
setSideBySide(boolean)
boolean isSetSideBySide()
Side By Side
' attribute is set.
unsetSideBySide()
,
isSideBySide()
,
setSideBySide(boolean)
Cursor getCursor()
setCursor(Cursor)
,
ComponentPackage.getAxis_Cursor()
void setCursor(Cursor value)
Cursor
' containment reference.
value
- the new value of the 'Cursor' containment reference.getCursor()
double getLabelSpan()
isSetLabelSpan()
,
unsetLabelSpan()
,
setLabelSpan(double)
,
ComponentPackage.getAxis_LabelSpan()
void setLabelSpan(double value)
Label Span
' attribute.
value
- the new value of the 'Label Span' attribute.isSetLabelSpan()
,
unsetLabelSpan()
,
getLabelSpan()
void unsetLabelSpan()
Label Span
' attribute.
isSetLabelSpan()
,
getLabelSpan()
,
setLabelSpan(double)
boolean isSetLabelSpan()
Label Span
' attribute is set.
unsetLabelSpan()
,
getLabelSpan()
,
setLabelSpan(double)
int getAxisPercent()
isSetAxisPercent()
,
unsetAxisPercent()
,
setAxisPercent(int)
,
ComponentPackage.getAxis_AxisPercent()
void setAxisPercent(int value)
Axis Percent
' attribute.
value
- the new value of the 'Axis Percent' attribute.isSetAxisPercent()
,
unsetAxisPercent()
,
getAxisPercent()
void unsetAxisPercent()
Axis Percent
' attribute.
isSetAxisPercent()
,
getAxisPercent()
,
setAxisPercent(int)
boolean isSetAxisPercent()
Axis Percent
' attribute is set.
unsetAxisPercent()
,
getAxisPercent()
,
setAxisPercent(int)
Series[] getRuntimeSeries()
Axis copyInstance()
copyInstance
in interface IChartObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |