org.eclipse.birt.chart.model.component
Interface Axis

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
AxisImpl

public interface Axis
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Axis'. This type defines the basic elements that are expected in any axis. This can further be extended for special axis types.

The following features are supported:

See Also:
ComponentPackage.getAxis()

Field Summary
static int ANCILLARY_BASE
           
static int BASE
           
static int ORTHOGONAL
           
 
Method Summary
 org.eclipse.emf.common.util.EList getAncillaryAxes()
          Returns the value of the 'Ancillary Axes' containment reference list.
 org.eclipse.emf.common.util.EList getAssociatedAxes()
          Returns the value of the 'Associated Axes' containment reference list.
 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.
 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 getMarkerLines()
          Returns the value of the 'Marker Lines' containment reference list.
 org.eclipse.emf.common.util.EList 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 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 getTriggers()
          Returns the value of the 'Triggers' containment reference list.
 AxisType getType()
          Returns the value of the 'Type' attribute.
 boolean isCategoryAxis()
          Returns the value of the 'Category Axis' attribute.
 boolean isPercent()
          Returns the value of the 'Percent' attribute.
 boolean isPrimaryAxis()
          Returns the value of the 'Primary Axis' attribute.
 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 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 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 isStaggered()
          Returns the value of the 'Staggered' attribute.
 void setCategoryAxis(boolean value)
          Sets the value of the 'Category Axis' attribute.
 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 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 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 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 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 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, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

BASE

public static final int BASE
See Also:
Constant Field Values

ORTHOGONAL

public static final int ORTHOGONAL
See Also:
Constant Field Values

ANCILLARY_BASE

public static final int ANCILLARY_BASE
See Also:
Constant Field Values
Method Detail

getType

public AxisType getType()
Returns the value of the 'Type' attribute. The default value is "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:
Linear
Double
Logarithmic
Double
Date/Time
Calendar
Text
String
Holds the type of Axis.

Returns:
the value of the 'Type' attribute.
See Also:
AxisType, isSetType(), unsetType(), setType(AxisType), ComponentPackage.getAxis_Type()

setType

public void setType(AxisType value)
Sets the value of the 'Type' attribute.

Parameters:
value - the new value of the 'Type' attribute.
See Also:
AxisType, isSetType(), unsetType(), getType()

unsetType

public void unsetType()
Unsets the value of the 'Type' attribute.

See Also:
isSetType(), getType(), setType(AxisType)

isSetType

public boolean isSetType()
Returns whether the value of the 'Type' attribute is set.

Returns:
whether the value of the 'Type' attribute is set.
See Also:
unsetType(), getType(), setType(AxisType)

getTitle

public 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(Label), ComponentPackage.getAxis_Title()

setTitle

public void setTitle(Label value)
Sets the value of the 'Title' containment reference.

Parameters:
value - the new value of the 'Title' containment reference.
See Also:
getTitle()

getSubTitle

public 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(Label), ComponentPackage.getAxis_SubTitle()

setSubTitle

public void setSubTitle(Label value)
Sets the value of the 'Sub Title' containment reference.

Parameters:
value - the new value of the 'Sub Title' containment reference.
See Also:
getSubTitle()

getTitlePosition

public Position getTitlePosition()
Returns the value of the 'Title Position' attribute. The default value is "Above". The literals are from the enumeration Position. Specifies where the title for the axis should be displayed.

Returns:
the value of the 'Title Position' attribute.
See Also:
Position, isSetTitlePosition(), unsetTitlePosition(), setTitlePosition(Position), ComponentPackage.getAxis_TitlePosition()

setTitlePosition

public void setTitlePosition(Position value)
Sets the value of the ' Title Position' attribute.

Parameters:
value - the new value of the 'Title Position' attribute.
See Also:
Position, isSetTitlePosition(), unsetTitlePosition(), getTitlePosition()

unsetTitlePosition

public void unsetTitlePosition()
Unsets the value of the ' Title Position' attribute.

See Also:
isSetTitlePosition(), getTitlePosition(), setTitlePosition(Position)

isSetTitlePosition

public 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:
unsetTitlePosition(), getTitlePosition(), setTitlePosition(Position)

getAssociatedAxes

public org.eclipse.emf.common.util.EList getAssociatedAxes()
Returns the value of the 'Associated Axes' containment reference list. The list contents are of type 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.

Returns:
the value of the 'Associated Axes' containment reference list.
See Also:
ComponentPackage.getAxis_AssociatedAxes()

getAncillaryAxes

public org.eclipse.emf.common.util.EList getAncillaryAxes()
Returns the value of the 'Ancillary Axes' containment reference list. The list contents are of type Axis. Holds the value ancillary base axes associated with this axis.

Returns:
the value of the 'Ancillary Axes' containment reference list.
See Also:
ComponentPackage.getAxis_AncillaryAxes()

getSeriesDefinitions

public org.eclipse.emf.common.util.EList getSeriesDefinitions()
Returns the value of the 'Series Definitions' containment reference list. The list contents are of type SeriesDefinition. Defines the source of the series.

Returns:
the value of the 'Series Definitions' containment reference list.
See Also:
ComponentPackage.getAxis_SeriesDefinitions()

getGapWidth

public 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:
isSetGapWidth(), unsetGapWidth(), setGapWidth(double), ComponentPackage.getAxis_GapWidth()

setGapWidth

public void setGapWidth(double value)
Sets the value of the 'Gap Width' attribute.

Parameters:
value - the new value of the 'Gap Width' attribute.
See Also:
isSetGapWidth(), unsetGapWidth(), getGapWidth()

unsetGapWidth

public void unsetGapWidth()
Unsets the value of the 'Gap Width' attribute.

See Also:
isSetGapWidth(), getGapWidth(), setGapWidth(double)

isSetGapWidth

public 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:
unsetGapWidth(), getGapWidth(), setGapWidth(double)

getOrientation

public Orientation getOrientation()
Returns the value of the 'Orientation' attribute. The default value is "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.

Returns:
the value of the 'Orientation' attribute.
See Also:
Orientation, isSetOrientation(), unsetOrientation(), setOrientation(Orientation), ComponentPackage.getAxis_Orientation()

setOrientation

public void setOrientation(Orientation value)
Sets the value of the 'Orientation' attribute.

Parameters:
value - the new value of the 'Orientation' attribute.
See Also:
Orientation, isSetOrientation(), unsetOrientation(), getOrientation()

unsetOrientation

public void unsetOrientation()
Unsets the value of the 'Orientation' attribute.

See Also:
isSetOrientation(), getOrientation(), setOrientation(Orientation)

isSetOrientation

public boolean isSetOrientation()
Returns whether the value of the ' Orientation' attribute is set.

Returns:
whether the value of the 'Orientation' attribute is set.
See Also:
unsetOrientation(), getOrientation(), setOrientation(Orientation)

getLineAttributes

public 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(LineAttributes), ComponentPackage.getAxis_LineAttributes()

setLineAttributes

public void setLineAttributes(LineAttributes value)
Sets the value of the 'Line Attributes' containment reference.

Parameters:
value - the new value of the 'Line Attributes' containment reference.
See Also:
getLineAttributes()

getLabel

public 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(Label), ComponentPackage.getAxis_Label()

setLabel

public void setLabel(Label value)
Sets the value of the 'Label' containment reference.

Parameters:
value - the new value of the 'Label' containment reference.
See Also:
getLabel()

getFormatSpecifier

public 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(FormatSpecifier), ComponentPackage.getAxis_FormatSpecifier()

setFormatSpecifier

public void setFormatSpecifier(FormatSpecifier value)
Sets the value of the 'Format Specifier' containment reference.

Parameters:
value - the new value of the 'Format Specifier' containment reference.
See Also:
getFormatSpecifier()

getLabelPosition

public Position getLabelPosition()
Returns the value of the 'Label Position' attribute. The default value is "Above". The literals are from the enumeration Position. Specifies where the labels for the axis should be displayed.

Returns:
the value of the 'Label Position' attribute.
See Also:
Position, isSetLabelPosition(), unsetLabelPosition(), setLabelPosition(Position), ComponentPackage.getAxis_LabelPosition()

setLabelPosition

public void setLabelPosition(Position value)
Sets the value of the ' Label Position' attribute.

Parameters:
value - the new value of the 'Label Position' attribute.
See Also:
Position, isSetLabelPosition(), unsetLabelPosition(), getLabelPosition()

unsetLabelPosition

public void unsetLabelPosition()
Unsets the value of the ' Label Position' attribute.

See Also:
isSetLabelPosition(), getLabelPosition(), setLabelPosition(Position)

isSetLabelPosition

public 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:
unsetLabelPosition(), getLabelPosition(), setLabelPosition(Position)

isStaggered

public 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:
isSetStaggered(), unsetStaggered(), setStaggered(boolean), ComponentPackage.getAxis_Staggered()

setStaggered

public void setStaggered(boolean value)
Sets the value of the 'Staggered' attribute.

Parameters:
value - the new value of the 'Staggered' attribute.
See Also:
isSetStaggered(), unsetStaggered(), isStaggered()

unsetStaggered

public void unsetStaggered()
Unsets the value of the 'Staggered' attribute.

See Also:
isSetStaggered(), isStaggered(), setStaggered(boolean)

isSetStaggered

public boolean isSetStaggered()
Returns whether the value of the ' Staggered' attribute is set.

Returns:
whether the value of the 'Staggered' attribute is set.
See Also:
unsetStaggered(), isStaggered(), setStaggered(boolean)

getInterval

public 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:
isSetInterval(), unsetInterval(), setInterval(int), ComponentPackage.getAxis_Interval()

setInterval

public void setInterval(int value)
Sets the value of the 'Interval' attribute.

Parameters:
value - the new value of the 'Interval' attribute.
See Also:
isSetInterval(), unsetInterval(), getInterval()

unsetInterval

public void unsetInterval()
Unsets the value of the 'Interval' attribute.

See Also:
isSetInterval(), getInterval(), setInterval(int)

isSetInterval

public boolean isSetInterval()
Returns whether the value of the 'Interval' attribute is set.

Returns:
whether the value of the 'Interval' attribute is set.
See Also:
unsetInterval(), getInterval(), setInterval(int)

getMarkerLines

public org.eclipse.emf.common.util.EList getMarkerLines()
Returns the value of the 'Marker Lines' containment reference list. The list contents are of type MarkerLine. 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:
ComponentPackage.getAxis_MarkerLines()

getMarkerRanges

public org.eclipse.emf.common.util.EList getMarkerRanges()
Returns the value of the 'Marker Ranges' containment reference list. The list contents are of type 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.

Returns:
the value of the 'Marker Ranges' containment reference list.
See Also:
ComponentPackage.getAxis_MarkerRanges()

getTriggers

public org.eclipse.emf.common.util.EList getTriggers()
Returns the value of the 'Triggers' containment reference list. The list contents are of type Trigger. Holds the triggers for the axis.

Returns:
the value of the 'Triggers' containment reference list.
See Also:
ComponentPackage.getAxis_Triggers()

getMajorGrid

public 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(Grid), ComponentPackage.getAxis_MajorGrid()

setMajorGrid

public void setMajorGrid(Grid value)
Sets the value of the 'Major Grid' containment reference.

Parameters:
value - the new value of the 'Major Grid' containment reference.
See Also:
getMajorGrid()

getMinorGrid

public 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(Grid), ComponentPackage.getAxis_MinorGrid()

setMinorGrid

public void setMinorGrid(Grid value)
Sets the value of the 'Minor Grid' containment reference.

Parameters:
value - the new value of the 'Minor Grid' containment reference.
See Also:
getMinorGrid()

getScale

public 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(Scale), ComponentPackage.getAxis_Scale()

setScale

public void setScale(Scale value)
Sets the value of the 'Scale' containment reference.

Parameters:
value - the new value of the 'Scale' containment reference.
See Also:
getScale()

getOrigin

public 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(AxisOrigin), ComponentPackage.getAxis_Origin()

setOrigin

public void setOrigin(AxisOrigin value)
Sets the value of the 'Origin' containment reference.

Parameters:
value - the new value of the 'Origin' containment reference.
See Also:
getOrigin()

isPrimaryAxis

public 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:
isSetPrimaryAxis(), unsetPrimaryAxis(), setPrimaryAxis(boolean), ComponentPackage.getAxis_PrimaryAxis()

setPrimaryAxis

public void setPrimaryAxis(boolean value)
Sets the value of the 'Primary Axis' attribute.

Parameters:
value - the new value of the 'Primary Axis' attribute.
See Also:
isSetPrimaryAxis(), unsetPrimaryAxis(), isPrimaryAxis()

unsetPrimaryAxis

public void unsetPrimaryAxis()
Unsets the value of the 'Primary Axis' attribute.

See Also:
isSetPrimaryAxis(), isPrimaryAxis(), setPrimaryAxis(boolean)

isSetPrimaryAxis

public 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:
unsetPrimaryAxis(), isPrimaryAxis(), setPrimaryAxis(boolean)

isCategoryAxis

public 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:
isSetCategoryAxis(), unsetCategoryAxis(), setCategoryAxis(boolean), ComponentPackage.getAxis_CategoryAxis()

setCategoryAxis

public void setCategoryAxis(boolean value)
Sets the value of the 'Category Axis' attribute.

Parameters:
value - the new value of the 'Category Axis' attribute.
See Also:
isSetCategoryAxis(), unsetCategoryAxis(), isCategoryAxis()

unsetCategoryAxis

public void unsetCategoryAxis()
Unsets the value of the ' Category Axis' attribute.

See Also:
isSetCategoryAxis(), isCategoryAxis(), setCategoryAxis(boolean)

isSetCategoryAxis

public 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:
unsetCategoryAxis(), isCategoryAxis(), setCategoryAxis(boolean)

isPercent

public 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:
isSetPercent(), unsetPercent(), setPercent(boolean), ComponentPackage.getAxis_Percent()

setPercent

public void setPercent(boolean value)
Sets the value of the 'Percent' attribute.

Parameters:
value - the new value of the 'Percent' attribute.
See Also:
isSetPercent(), unsetPercent(), isPercent()

unsetPercent

public void unsetPercent()
Unsets the value of the 'Percent' attribute.

See Also:
isSetPercent(), isPercent(), setPercent(boolean)

isSetPercent

public boolean isSetPercent()
Returns whether the value of the 'Percent' attribute is set.

Returns:
whether the value of the 'Percent' attribute is set.
See Also:
unsetPercent(), isPercent(), setPercent(boolean)

getRuntimeSeries

public Series[] getRuntimeSeries()
Returns:
All runtime series associated with a particular axis


Copyright © 2005-2007 Actuate Corp. All rights reserved.