Interface Chart

    • Field Detail

      • VERSION

        static final java.lang.String VERSION
        The current chart version, the number should be modified when chart mode is updated.
        See Also:
        Constant Field Values
    • Method Detail

      • getType

        java.lang.String getType()
        Returns the value of the 'Type' attribute. Gets the type of this chart. Specifies the type of this chart.
        Returns:
        the value of the 'Type' attribute.
        See Also:
        setType(String), ModelPackage.getChart_Type()
      • setType

        void setType​(java.lang.String value)
        Sets the value of the 'Type' attribute. Sets the type of this chart. This is primarily used in the UI to enable re-entrant dialogs.
        Parameters:
        value - the new value of the 'Type' attribute.
        See Also:
        getType()
      • getSubType

        java.lang.String getSubType()
        Returns the value of the 'Sub Type' attribute. Gets the sub-type of this chart. Specifies the sub-type of this chart.
        Returns:
        the value of the 'Sub Type' attribute.
        See Also:
        setSubType(String), ModelPackage.getChart_SubType()
      • setSubType

        void setSubType​(java.lang.String value)
        Sets the value of the 'Sub Type' attribute. Sets the sub-type of this chart. This is primarily used in the UI to enable re-entrant dialogs.
        Parameters:
        value - the new value of the 'Sub Type' attribute.
        See Also:
        getSubType()
      • getDescription

        Text getDescription()
        Returns the value of the 'Description' containment reference. Gets the description string for the chart. Description of the chart...could be used as tooltip value for example.
        Returns:
        the value of the 'Description' containment reference.
        See Also:
        setDescription(Text), ModelPackage.getChart_Description()
      • setDescription

        void setDescription​(Text value)
        Sets the value of the 'Description' containment reference. Sets the description string for the chart.
        Parameters:
        value - the new value of the 'Description' containment reference.
        See Also:
        getDescription()
      • getBlock

        Block getBlock()
        Returns the value of the 'Block' containment reference. Gets the Blockinstance 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.
        Returns:
        the value of the 'Block' containment reference.
        See Also:
        setBlock(Block), ModelPackage.getChart_Block()
      • setBlock

        void setBlock​(Block value)
        Sets the value of the 'Block' containment reference. Sets the Blockinstance representing the chart as a whole.
        Parameters:
        value - the new value of the 'Block' containment reference.
        See Also:
        getBlock()
      • getScript

        java.lang.String getScript()
        Returns the value of the 'Script' attribute. Gets the script text associated with the chart. Holds the script for the chart.
        Returns:
        the value of the 'Script' attribute.
        See Also:
        setScript(String), ModelPackage.getChart_Script()
      • setScript

        void setScript​(java.lang.String value)
        Sets the value of the '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.
        Parameters:
        value - the new value of the 'Script' attribute.
        See Also:
        getScript()
      • getUnits

        java.lang.String getUnits()
        Returns the value of the 'Units' attribute. Gets the Units of Measurement being used for this chart. Holds the units of measurement for the model.
        Returns:
        the value of the 'Units' attribute.
        See Also:
        setUnits(String), ModelPackage.getChart_Units()
      • setUnits

        void setUnits​(java.lang.String value)
        Sets the value of the 'Units' attribute. Sets the Units of Measurement to be used for this chart.
        Parameters:
        value - the new value of the 'Units' attribute.
        See Also:
        getUnits()
      • setSeriesThickness

        void setSeriesThickness​(double value)
        Sets the value of the '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.
        Parameters:
        value - the new value of the 'Series Thickness' attribute.
        See Also:
        isSetSeriesThickness(), unsetSeriesThickness(), getSeriesThickness()
      • getExtendedProperties

        org.eclipse.emf.common.util.EList<ExtendedProperty> getExtendedProperties()
        Returns the value of the 'Extended Properties' containment reference list. The list contents are of type 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.
        Returns:
        the value of the 'Extended Properties' containment reference list.
        See Also:
        ModelPackage.getChart_ExtendedProperties()
      • getSampleData

        SampleData getSampleData()
        Returns the value of the 'Sample Data' containment reference. Gets the sample data for the chart. The sample data is used to display the chart at design-time e.g. in the Preview window of the Chart Builder. Holds a collection of sample values for use by the chart. This type is likely to be highly version dependent.
        Returns:
        the value of the 'Sample Data' containment reference.
        See Also:
        setSampleData(SampleData), ModelPackage.getChart_SampleData()
      • setSampleData

        void setSampleData​(SampleData value)
        Sets the value of the 'Sample Data' containment reference.
        Parameters:
        value - the new value of the 'Sample Data' containment reference.
        See Also:
        getSampleData()
      • getStyles

        org.eclipse.emf.common.util.EList<StyleMap> getStyles()
        Returns the value of the 'Styles' containment reference list. The list contents are of type StyleMap. Element "Styles" holds a collection of style maps for use by the chart.
        Returns:
        the value of the 'Styles' containment reference list.
        See Also:
        ModelPackage.getChart_Styles()
      • setInteractivity

        void setInteractivity​(Interactivity value)
        Sets the value of the 'Interactivity' containment reference.
        Parameters:
        value - the new value of the 'Interactivity' containment reference.
        See Also:
        getInteractivity()
      • getEmptyMessage

        Label getEmptyMessage()
        Returns the value of the 'Empty Message' containment reference. Element "EmptyMessage" provides the message text to be displayed in the place of plot area when the chart contains no data. By default, it's visibility is false, which indicates if the chart contains no data, the whole chart will be hidden, and no label will be shown.
        Returns:
        the value of the 'Empty Message' containment reference.
        See Also:
        setEmptyMessage(Label), ModelPackage.getChart_EmptyMessage()
      • setEmptyMessage

        void setEmptyMessage​(Label value)
        Sets the value of the 'Empty Message' containment reference.
        Parameters:
        value - the new value of the 'Empty Message' containment reference.
        See Also:
        getEmptyMessage()
      • getLegend

        Legend getLegend()
        Convenience method that gets the Legend Block for the chart. Note: Manually written
        Returns:
        Legend The layout block that represents the legend area in the chart.
      • getPlot

        Plot getPlot()
        Convenience method that gets the Plot Block for the chart. Note: Manually written
        Returns:
        Plot The layout block that represents the plot area in the chart.
      • getTitle

        TitleBlock getTitle()
        Convenience method that gets the Title Block for the chart. Note: Manually written
        Returns:
        TitleBlock The layout block that represents the title area in the chart.
      • getSeriesForLegend

        SeriesDefinition[] getSeriesForLegend()
        This method returns all series whose captions/markers are to be rendered in the Legend content
        Returns:
        SeriesDefinition array
      • clearSections

        void clearSections​(int iSectionType)
        This method walks through the model and clears specific model sections that are not required at deployment time.
        Parameters:
        iSectionType - Possible values are IConstants.RUN_TIME and IConstants.USER_INTERFACE
      • createSampleRuntimeSeries

        void createSampleRuntimeSeries()
        Builds runtime series instances for each design-time series based on the sample data contained in the model