|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Chart
A representation of the model object 'Chart'. This is the basic type from which all charts should be extended. It defines the basic elements that are expected to be present for all charts.
The following features are supported:
Version
Type
Sub Type
Description
Block
Dimension
Script
Units
Series Thickness
Grid Column Count
Extended Properties
Sample Data
Styles
Interactivity
ModelPackage.getChart()
Method Summary | |
---|---|
void |
clearSections(int iSectionType)
This method walks through the model and clears specific model sections that are not required at deployment time. |
void |
createSampleRuntimeSeries()
Builds runtime series instances for each design-time series based on the sample data contained in the model |
Block |
getBlock()
Returns the value of the 'Block' containment reference. |
Text |
getDescription()
Returns the value of the 'Description' containment reference. |
ChartDimension |
getDimension()
Returns the value of the 'Dimension' attribute. |
org.eclipse.emf.common.util.EList |
getExtendedProperties()
Returns the value of the 'Extended Properties' containment reference list. |
int |
getGridColumnCount()
Returns the value of the 'Grid Column Count' attribute. |
Interactivity |
getInteractivity()
Returns the value of the 'Interactivity' containment reference. |
Legend |
getLegend()
Convenience method that gets the Legend Block for the chart. |
Plot |
getPlot()
Convenience method that gets the Plot Block for the chart. |
SampleData |
getSampleData()
Returns the value of the 'Sample Data' containment reference. |
java.lang.String |
getScript()
Returns the value of the 'Script' attribute. |
SeriesDefinition[] |
getSeriesForLegend()
This method returns all series whose captions/markers are to be rendered in the Legend content |
double |
getSeriesThickness()
Returns the value of the 'Series Thickness' attribute. |
org.eclipse.emf.common.util.EList |
getStyles()
Returns the value of the 'Styles' containment reference list. |
java.lang.String |
getSubType()
Returns the value of the 'Sub Type' attribute. |
TitleBlock |
getTitle()
Convenience method that gets the Title Block for the chart. |
java.lang.String |
getType()
Returns the value of the 'Type' attribute. |
java.lang.String |
getUnits()
Returns the value of the 'Units' attribute. |
java.lang.String |
getVersion()
Returns the value of the 'Version' attribute. |
boolean |
isSetDimension()
Returns whether the value of the ' Dimension ' attribute is set. |
boolean |
isSetGridColumnCount()
Returns whether the value of the ' Grid Column Count ' attribute is set. |
boolean |
isSetSeriesThickness()
Returns whether the value of the ' Series Thickness ' attribute is set. |
boolean |
isSetVersion()
Returns whether the value of the ' Version ' attribute is set. |
void |
setBlock(Block value)
Sets the value of the ' Block ' containment reference. |
void |
setDescription(Text value)
Sets the value of the ' Description ' containment reference. |
void |
setDimension(ChartDimension value)
Sets the value of the ' Dimension ' attribute. |
void |
setGridColumnCount(int value)
Sets the value of the ' Grid Column Count ' attribute. |
void |
setInteractivity(Interactivity value)
Sets the value of the ' Interactivity ' containment reference. |
void |
setSampleData(SampleData value)
Sets the value of the ' Sample Data ' containment reference. |
void |
setScript(java.lang.String value)
Sets the value of the ' Script ' attribute. |
void |
setSeriesThickness(double value)
Sets the value of the ' Series Thickness ' attribute. |
void |
setSubType(java.lang.String value)
Sets the value of the ' Sub Type ' attribute. |
void |
setType(java.lang.String value)
Sets the value of the ' Type ' attribute. |
void |
setUnits(java.lang.String value)
Sets the value of the ' Units ' attribute. |
void |
setVersion(java.lang.String value)
Sets the value of the ' Version ' attribute. |
void |
unsetDimension()
Unsets the value of the ' Dimension ' attribute. |
void |
unsetGridColumnCount()
Unsets the value of the ' Grid Column Count ' attribute. |
void |
unsetSeriesThickness()
Unsets the value of the ' Series Thickness ' attribute. |
void |
unsetVersion()
Unsets the value of the ' Version ' 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 |
Method Detail |
---|
java.lang.String getVersion()
"1.0.0"
.
Specifies the version number of this chart.
isSetVersion()
,
unsetVersion()
,
setVersion(String)
,
ModelPackage.getChart_Version()
void setVersion(java.lang.String value)
Version
' attribute.
value
- the new value of the 'Version' attribute.isSetVersion()
,
unsetVersion()
,
getVersion()
void unsetVersion()
Version
' attribute.
isSetVersion()
,
getVersion()
,
setVersion(String)
boolean isSetVersion()
Version
' attribute is set.
unsetVersion()
,
getVersion()
,
setVersion(String)
java.lang.String getType()
setType(String)
,
ModelPackage.getChart_Type()
void setType(java.lang.String value)
Type
' attribute. Sets the type of this chart. This is primarily used in the UI to enable re-entrant dialogs.
value
- the new value of the 'Type' attribute.getType()
java.lang.String getSubType()
setSubType(String)
,
ModelPackage.getChart_SubType()
void setSubType(java.lang.String value)
Sub Type
' attribute. Sets the sub-type of this chart. This is primarily used in the UI to enable re-entrant
dialogs.
value
- the new value of the 'Sub Type' attribute.getSubType()
Text getDescription()
setDescription(Text)
,
ModelPackage.getChart_Description()
void setDescription(Text value)
Description
' containment reference.
Sets the description string for the chart.
value
- the new value of the 'Description' containment reference.getDescription()
Block getBlock()
Block
instance for the chart.
Defines a virtual entity that is independent of any chart element, but contains them and can be moved around in
the chart area for rendering.
setBlock(Block)
,
ModelPackage.getChart_Block()
void setBlock(Block value)
Block
' containment reference.
Sets the Block
instance
representing the chart as a whole.
value
- the new value of the 'Block' containment reference.getBlock()
ChartDimension getDimension()
"Two_Dimensional"
. The literals are from the enumeration
ChartDimension
. Gets the dimensions for
the chart. The dimensions here are essentially an indicator of how the chart will appear when rendered and do not
have a bearing on the number of variables or facets to the data.
Defines the dimensions the chart has.
ChartDimension
,
isSetDimension()
,
unsetDimension()
,
setDimension(ChartDimension)
,
ModelPackage.getChart_Dimension()
void setDimension(ChartDimension value)
Dimension
' attribute.
Sets the dimensions for this chart.
value
- the new value of the 'Dimension' attribute.ChartDimension
,
isSetDimension()
,
unsetDimension()
,
getDimension()
void unsetDimension()
Dimension
' attribute.
isSetDimension()
,
getDimension()
,
setDimension(ChartDimension)
boolean isSetDimension()
Dimension
' attribute is set.
unsetDimension()
,
getDimension()
,
setDimension(ChartDimension)
java.lang.String getScript()
setScript(String)
,
ModelPackage.getChart_Script()
void setScript(java.lang.String value)
Script
' attribute. Sets the script text associated with the chart. For the script contents to be used at runtime
a mechanism will need to be in place that understands and can evaluate the contents of the script.
value
- the new value of the 'Script' attribute.getScript()
java.lang.String getUnits()
setUnits(String)
,
ModelPackage.getChart_Units()
void setUnits(java.lang.String value)
Units
' attribute. Sets the Units of Measurement to be used for this chart.
value
- the new value of the 'Units' attribute.getUnits()
double getSeriesThickness()
isSetSeriesThickness()
,
unsetSeriesThickness()
,
setSeriesThickness(double)
,
ModelPackage.getChart_SeriesThickness()
void setSeriesThickness(double value)
Series Thickness
' attribute.
Sets the series thickness as a percentage. This is the thickness used to
render the shape representing the series when the chart is rendered in 3D or 2D with Depth formats.
value
- the new value of the 'Series Thickness' attribute.isSetSeriesThickness()
,
unsetSeriesThickness()
,
getSeriesThickness()
void unsetSeriesThickness()
Series Thickness
' attribute.
isSetSeriesThickness()
,
getSeriesThickness()
,
setSeriesThickness(double)
boolean isSetSeriesThickness()
Series Thickness
' attribute is set.
unsetSeriesThickness()
,
getSeriesThickness()
,
setSeriesThickness(double)
int getGridColumnCount()
isSetGridColumnCount()
,
unsetGridColumnCount()
,
setGridColumnCount(int)
,
ModelPackage.getChart_GridColumnCount()
void setGridColumnCount(int value)
Grid Column Count
' attribute.
value
- the new value of the 'Grid Column Count' attribute.isSetGridColumnCount()
,
unsetGridColumnCount()
,
getGridColumnCount()
void unsetGridColumnCount()
Grid Column Count
' attribute.
isSetGridColumnCount()
,
getGridColumnCount()
,
setGridColumnCount(int)
boolean isSetGridColumnCount()
Grid Column Count
' attribute is set.
unsetGridColumnCount()
,
getGridColumnCount()
,
setGridColumnCount(int)
org.eclipse.emf.common.util.EList getExtendedProperties()
ExtendedProperty
.
Holds a generic list of properties (as name-value pairs) for minor extensions to the chart. Preferred way to add
properties remains through modification of schema.
ModelPackage.getChart_ExtendedProperties()
SampleData getSampleData()
setSampleData(SampleData)
,
ModelPackage.getChart_SampleData()
void setSampleData(SampleData value)
Sample Data
' containment reference.
value
- the new value of the 'Sample Data' containment reference.getSampleData()
org.eclipse.emf.common.util.EList getStyles()
StyleMap
.
Holds a collection of style maps for use by the chart.
ModelPackage.getChart_Styles()
Interactivity getInteractivity()
setInteractivity(Interactivity)
,
ModelPackage.getChart_Interactivity()
void setInteractivity(Interactivity value)
Interactivity
' containment reference.
value
- the new value of the 'Interactivity' containment reference.getInteractivity()
Legend getLegend()
Plot getPlot()
TitleBlock getTitle()
SeriesDefinition[] getSeriesForLegend()
void clearSections(int iSectionType)
iSectionType
- Possible values are IConstants.RUN_TIME and IConstants.USER_INTERFACEvoid createSampleRuntimeSeries()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |