|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChartWithAxes
A representation of the model object 'Chart With Axes'. This is a chart with axes...(e.g. Bar Chart, Line Chart, etc). It contains one base axis and one or more orthoganal axes.
The following features are supported:
ModelPackage.getChartWithAxes()
Field Summary |
---|
Fields inherited from interface org.eclipse.birt.chart.model.Chart |
---|
VERSION |
Method Summary | |
---|---|
ChartWithAxes |
copyInstance()
A convenient method to get an instance copy. |
Axis |
getAncillaryBaseAxis(Axis axBase)
This method returns the ancillary base axis for a given base axis NOTE: Manually written |
org.eclipse.emf.common.util.EList<Axis> |
getAxes()
Returns the value of the 'Axes' containment reference list. |
Axis[] |
getBaseAxes()
This method returns all base axes associated with the chart model NOTE: Manually written |
Fill |
getFloorFill()
Returns the value of the 'Floor Fill' containment reference. |
Orientation |
getOrientation()
Returns the value of the 'Orientation' attribute. |
Axis[] |
getOrthogonalAxes(Axis axBase,
boolean bIncludePrimary)
This method returns all (primary and overlay) orthogonal axes for a given base axis If the primary orthogonal is requested for, it would be returned as the first element in the array NOTE: Manually written |
Axis[] |
getPrimaryBaseAxes()
This method returns all primary base axes associated with the chart model NOTE: Manually written |
Axis |
getPrimaryOrthogonalAxis(Axis axBase)
This method returns the primary orthogonal axis for a given base axis NOTE: Manually written |
Rotation3D |
getRotation()
Returns the value of the 'Rotation' containment reference. |
Series[] |
getSeries(int iBaseOrOrthogonal)
This method needs to be called after the chart has been populated with runtime datasets and runtime series have been associated with each of the axes. |
double |
getUnitSpacing()
Returns the value of the 'Unit Spacing' attribute. |
Fill |
getWallFill()
Returns the value of the 'Wall Fill' containment reference. |
boolean |
isReverseCategory()
Returns the value of the 'Reverse Category' attribute. |
boolean |
isSetOrientation()
Returns whether the value of the ' Orientation ' attribute is set. |
boolean |
isSetReverseCategory()
Returns whether the value of the ' Reverse Category ' attribute is set. |
boolean |
isSetStudyLayout()
Returns whether the value of the ' Study Layout ' attribute is set. |
boolean |
isSetUnitSpacing()
Returns whether the value of the ' Unit Spacing ' attribute is set. |
boolean |
isStudyLayout()
Returns the value of the 'Study Layout' attribute. |
boolean |
isTransposed()
A convenience method used to determine if the plot is transposed or not. |
void |
setFloorFill(Fill value)
Sets the value of the ' Floor Fill ' containment reference. |
void |
setOrientation(Orientation value)
Sets the value of the ' Orientation ' attribute. |
void |
setReverseCategory(boolean value)
Sets the value of the ' Reverse Category ' attribute. |
void |
setRotation(Rotation3D value)
Sets the value of the ' Rotation ' containment reference. |
void |
setStudyLayout(boolean value)
Sets the value of the ' Study Layout ' attribute. |
void |
setTransposed(boolean bTransposed)
A convenience method used to specify if the plot is transposed or not. |
void |
setUnitSpacing(double value)
Sets the value of the ' Unit Spacing ' attribute. |
void |
setWallFill(Fill value)
Sets the value of the ' Wall Fill ' containment reference. |
void |
unsetOrientation()
Unsets the value of the ' Orientation ' attribute. |
void |
unsetReverseCategory()
Unsets the value of the ' Reverse Category ' attribute. |
void |
unsetStudyLayout()
Unsets the value of the ' Study Layout ' attribute. |
void |
unsetUnitSpacing()
Unsets the value of the ' Unit Spacing ' attribute. |
Methods inherited from interface org.eclipse.birt.chart.model.Chart |
---|
clearSections, createSampleRuntimeSeries, getBlock, getDescription, getDimension, getEmptyMessage, getExtendedProperties, getGridColumnCount, getInteractivity, getLegend, getPlot, getSampleData, getScript, getSeriesForLegend, getSeriesThickness, getStyles, getSubType, getTitle, getType, getUnits, getVersion, isSetDimension, isSetGridColumnCount, isSetSeriesThickness, isSetVersion, setBlock, setDescription, setDimension, setEmptyMessage, setGridColumnCount, setInteractivity, setSampleData, setScript, setSeriesThickness, setSubType, setType, setUnits, setVersion, unsetDimension, unsetGridColumnCount, unsetSeriesThickness, unsetVersion |
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 |
Method Detail |
---|
org.eclipse.emf.common.util.EList<Axis> getAxes()
Axis
. Gets the list of base axes for the
chart. 'Base' axes are the Category axes for the chart if the chart has any. Each of these axes can contain zero
or more 'Orthogonal' axes.
Holds all the base axes for the chart.
ModelPackage.getChartWithAxes_Axes()
Fill getWallFill()
setWallFill(Fill)
,
ModelPackage.getChartWithAxes_WallFill()
void setWallFill(Fill value)
Wall Fill
' containment reference.
value
- the new value of the 'Wall Fill' containment reference.getWallFill()
Fill getFloorFill()
setFloorFill(Fill)
,
ModelPackage.getChartWithAxes_FloorFill()
void setFloorFill(Fill value)
Floor Fill
' containment reference.
value
- the new value of the 'Floor Fill' containment reference.getFloorFill()
Orientation getOrientation()
"Horizontal"
. The literals are from the enumeration
Orientation
. Gets the orientation of the
chart as a whole. This drives the way the chart will be rendered and affects the orientations of other elements
throughout the chart.
Specifies whether the chart is a vertical or horizontal chart.
Orientation
,
isSetOrientation()
,
unsetOrientation()
,
setOrientation(Orientation)
,
ModelPackage.getChartWithAxes_Orientation()
void setOrientation(Orientation value)
Orientation
' attribute.
Sets the orientation of the chart as a whole. This drives the way the chart
will be rendered and affects the orientations of other elements throughout the chart.
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)
double getUnitSpacing()
isSetUnitSpacing()
,
unsetUnitSpacing()
,
setUnitSpacing(double)
,
ModelPackage.getChartWithAxes_UnitSpacing()
void setUnitSpacing(double value)
Unit Spacing
' attribute.
value
- the new value of the 'Unit Spacing' attribute.isSetUnitSpacing()
,
unsetUnitSpacing()
,
getUnitSpacing()
void unsetUnitSpacing()
Unit Spacing
' attribute.
isSetUnitSpacing()
,
getUnitSpacing()
,
setUnitSpacing(double)
boolean isSetUnitSpacing()
Unit Spacing
' attribute is set.
unsetUnitSpacing()
,
getUnitSpacing()
,
setUnitSpacing(double)
Rotation3D getRotation()
setRotation(Rotation3D)
,
ModelPackage.getChartWithAxes_Rotation()
void setRotation(Rotation3D value)
Rotation
' containment reference.
value
- the new value of the 'Rotation' containment reference.getRotation()
boolean isReverseCategory()
"false"
.
Specifies if the categories are in
reverse order
isSetReverseCategory()
,
unsetReverseCategory()
,
setReverseCategory(boolean)
,
ModelPackage.getChartWithAxes_ReverseCategory()
void setReverseCategory(boolean value)
Reverse Category
' attribute.
value
- the new value of the 'Reverse Category' attribute.isSetReverseCategory()
,
unsetReverseCategory()
,
isReverseCategory()
void unsetReverseCategory()
Reverse Category
' attribute.
isSetReverseCategory()
,
isReverseCategory()
,
setReverseCategory(boolean)
boolean isSetReverseCategory()
Reverse Category
' attribute is set.
unsetReverseCategory()
,
isReverseCategory()
,
setReverseCategory(boolean)
boolean isStudyLayout()
isSetStudyLayout()
,
unsetStudyLayout()
,
setStudyLayout(boolean)
,
ModelPackage.getChartWithAxes_StudyLayout()
void setStudyLayout(boolean value)
Study Layout
' attribute.
value
- the new value of the 'Study Layout' attribute.isSetStudyLayout()
,
unsetStudyLayout()
,
isStudyLayout()
void unsetStudyLayout()
Study Layout
' attribute.
isSetStudyLayout()
,
isStudyLayout()
,
setStudyLayout(boolean)
boolean isSetStudyLayout()
Study Layout
' attribute is set.
unsetStudyLayout()
,
isStudyLayout()
,
setStudyLayout(boolean)
Axis[] getBaseAxes()
Axis[] getPrimaryBaseAxes()
Axis[] getOrthogonalAxes(Axis axBase, boolean bIncludePrimary)
axBase
-
Axis getPrimaryOrthogonalAxis(Axis axBase)
axBase
-
Axis getAncillaryBaseAxis(Axis axBase)
axBase
-
Series[] getSeries(int iBaseOrOrthogonal)
iBaseOrOrthogonal
-
boolean isTransposed()
void setTransposed(boolean bTransposed)
ChartWithAxes copyInstance()
copyInstance
in interface Chart
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |