Interface Series

    • Method Detail

      • setVisible

        void setVisible​(boolean value)
        Sets the value of the 'Visible' attribute. Sets visibility of the series.
        Parameters:
        value - the new value of the 'Visible' attribute.
        See Also:
        isSetVisible(), unsetVisible(), isVisible()
      • setLabel

        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()
      • getDataDefinition

        org.eclipse.emf.common.util.EList<Query> getDataDefinition()
        Returns the value of the 'Data Definition' containment reference list. The list contents are of type org.eclipse.birt.chart.model.data.DataDefinition. Gets the list of data source definitions for this series. Defines the source of the data for the series. (e.g. Database field which will provide the values for the series).
        Returns:
        the value of the 'Data Definition' containment reference list.
        See Also:
        ComponentPackage.getSeries_DataDefinition()
      • getSeriesIdentifier

        java.lang.Object getSeriesIdentifier()
        Returns the value of the 'Series Identifier' attribute. Returns an identifier that represents the seriesKey runtime value which is rendered in the legend (if grouped by series)
        Returns:
        the value of the 'Series Identifier' attribute.
        See Also:
        #setSeriesIdentifier(String), ComponentPackage.getSeries_SeriesIdentifier()
      • setSeriesIdentifier

        void setSeriesIdentifier​(java.lang.Object value)
        Sets the value of the 'Series Identifier' attribute.
        Parameters:
        value - the new value of the 'Series Identifier' attribute.
        See Also:
        getSeriesIdentifier()
      • setDataPoint

        void setDataPoint​(DataPoint value)
        Sets the value of the 'Data Point' containment reference.
        Parameters:
        value - the new value of the 'Data Point' containment reference.
        See Also:
        getDataPoint()
      • getDataSets

        org.eclipse.emf.common.util.EMap<java.lang.String,​DataSet> getDataSets()
        Returns the value of the 'Data Sets' map. The key is of type String, and the value is of type DataSet, Holds the runtime data for the series.
        Returns:
        the value of the 'Data Sets' map.
        See Also:
        ComponentPackage.getSeries_DataSets()
      • getTriggers

        org.eclipse.emf.common.util.EList<Trigger> getTriggers()
        Returns the value of the 'Triggers' containment reference list. The list contents are of type Trigger. Triggers are the elements that define interactivity for chart components. They include the action to be performed as well as parameters that define the details of the action. Holds the triggers for the series.
        Returns:
        the value of the 'Triggers' containment reference list.
        See Also:
        ComponentPackage.getSeries_Triggers()
      • setCurveFitting

        void setCurveFitting​(CurveFitting value)
        Sets the value of the 'Curve Fitting' containment reference.
        Parameters:
        value - the new value of the 'Curve Fitting' containment reference.
        See Also:
        getCurveFitting()
      • setCursor

        void setCursor​(Cursor value)
        Sets the value of the 'Cursor' containment reference.
        Parameters:
        value - the new value of the 'Cursor' containment reference.
        See Also:
        getCursor()
      • canBeStacked

        boolean canBeStacked()
        Indicates if this series type may be rendered stacked with other series instances of the same type NOTE: Manually written
        Returns:
        true means this series can be stacked
      • canShareAxisUnit

        boolean canShareAxisUnit()
        Indicates if this series graphic element may share a scale unit with other similar elements. NOTE: Manually written
        Returns:
        true means this series can share scale unit
      • canParticipateInCombination

        boolean canParticipateInCombination()
        This method should return true if the series type can be used in a combination chart. NOTE: Manually written
        Returns:
        true means this series can be used in combination chart
      • translateFrom

        void translateFrom​(Series sourceSeries,
                           int iSeriesDefinitionIndex,
                           Chart chart)
        This method should modify the series instance to extract whatever information it can from the series provided...updating the model if necessary. This method should be overridden by each series type implementation in particular if the series type can participate in a combination. It will be called when converting from one series type to another. The iSeriesDefinitionIndex value is the index of the series definition among all series definitions at the same level (base or orthogonal) NOTE: Manually written
      • getDisplayName

        java.lang.String getDisplayName()
        This method should return a user-friendly name for the series type. NOTE: Manually written
        Returns:
        display name for the series type
      • getLabelPositionScope

        org.eclipse.birt.chart.util.NameSet getLabelPositionScope​(ChartDimension dimension)
        Returns supported label positions scope in current series. Label position set in series must be in one of these types.
        Parameters:
        dimension - chart dimension
        Returns:
        NameSet with supported label positions.
      • setDataSet

        void setDataSet​(DataSet dataSet)
        Sets the value dataSet.
        Parameters:
        dataSet -
      • getDataSet

        DataSet getDataSet()
        Returns the value dataSet.
        Returns:
        value data set
      • setDataSet

        void setDataSet​(java.lang.String userKey,
                        DataSet dataSet)
        Sets the user dataSet.
        Parameters:
        userKey -
        dataSet -
      • getDataSet

        DataSet getDataSet​(java.lang.String userkey)
        Returns the user dataSet.
        Parameters:
        userkey -
        Returns:
        user data set
      • isSingleCache

        boolean isSingleCache()
        The method indicates if painting requests of series should be added to a single cache.
        Returns:
        true if painting requests of series should be added to a single cache. False means creating a new Cache for each series.
      • getDefinedDataDefinitionIndex

        int[] getDefinedDataDefinitionIndex()
        Returns the index array of data definitions which must be defined. For instance, if there are two data definitions in series, and the first one can be not defined, this method will return 1 in integer array; if two of them must be defined, this method will return 0 and 1 in integer array.
        Returns:
        index array
        Since:
        2.6.1