Interface ChartWithAxes

  • All Superinterfaces:
    Chart, org.eclipse.emf.ecore.EObject, IChartObject, org.eclipse.emf.common.notify.Notifier
    All Known Implementing Classes:
    ChartWithAxesImpl

    public interface ChartWithAxes
    extends Chart
    A representation of the model object 'Chart With Axes'. ChartWithAxes represents a chart with axes. (e.g. Bar Chart, Line Chart, etc).

    To create an instance use the factory method:
    ChartWithAxesImpl.create( );

    At the moment only charts with one single base axis are supported, while one or more orthogonal axes can be associated with the base axis. In case of 3D charts, the z-axis is defined as an ancillary axis of the base axis.

    Following examples show the ways to retrieve the base axis of an instance of ChartWithAxes :
    ChartWithAxes cwa...
    Axis axBase = cwa.getAxes( ).get( 0 );
    or
    Axis axBase = cwa.getAxes( ).getPrimaryBaseAxes( )[0];

    To retrieve the primary orthogonal axis associated with the base axis use:

    Axis axOrth = getPrimaryOrthogonalAxis( axBase );

    To retireve all the orthogonal axes associated with the base axis use in/exclude the primary one use:

    Axis[] axOrths = getOrthogonalAxes( axBase, bIncludePrimary );
    To retrieve the z-axis use: Axis axAnci = getAncillaryBaseAxis( axBase );

    The following features are supported:

    See Also:
    ModelPackage.getChartWithAxes()
    • Method Detail

      • getAxes

        org.eclipse.emf.common.util.EList<Axis> getAxes()
        Returns the value of the 'Axes' containment reference list. The list contents are of type 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.
        Returns:
        the value of the 'Axes' containment reference list.
        See Also:
        ModelPackage.getChartWithAxes_Axes()
      • setWallFill

        void setWallFill​(Fill value)
        Sets the value of the 'Wall Fill' containment reference.
        Parameters:
        value - the new value of the 'Wall Fill' containment reference.
        See Also:
        getWallFill()
      • setFloorFill

        void setFloorFill​(Fill value)
        Sets the value of the 'Floor Fill' containment reference.
        Parameters:
        value - the new value of the 'Floor Fill' containment reference.
        See Also:
        getFloorFill()
      • getRotation

        Rotation3D getRotation()
        Returns the value of the 'Rotation' containment reference. Element "Rotation" of type Rotation3D is used for 3D charts, it specifies how many degrees the chart graphic is rotated around each of the three axes.
        The following example will set a 3D chart to be rotated -20 degrees around x-axis, 45 degrees around y-axis and 0 degrees around z-axis:

        ChartWithAxes cwa = ...
        Angle3D a3D = cwa .getRotation( ).getAngles( ) .get( 0 );
        a3D.set( -20, 45, 0 );

        Returns:
        the value of the 'Rotation' containment reference.
        See Also:
        setRotation(Rotation3D), ModelPackage.getChartWithAxes_Rotation()
      • setRotation

        void setRotation​(Rotation3D value)
        Sets the value of the 'Rotation' containment reference.
        Parameters:
        value - the new value of the 'Rotation' containment reference.
        See Also:
        getRotation()
      • getBaseAxes

        Axis[] getBaseAxes()
        This method returns all base axes associated with the chart model NOTE: Manually written
        Returns:
      • getPrimaryBaseAxes

        Axis[] getPrimaryBaseAxes()
        This method returns all primary base axes associated with the chart model NOTE: Manually written
        Returns:
      • getOrthogonalAxes

        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
        Parameters:
        axBase -
        Returns:
      • getPrimaryOrthogonalAxis

        Axis getPrimaryOrthogonalAxis​(Axis axBase)
        This method returns the primary orthogonal axis for a given base axis NOTE: Manually written
        Parameters:
        axBase -
        Returns:
      • getAncillaryBaseAxis

        Axis getAncillaryBaseAxis​(Axis axBase)
        This method returns the ancillary base axis for a given base axis NOTE: Manually written
        Parameters:
        axBase -
        Returns:
      • getSeries

        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.
        Parameters:
        iBaseOrOrthogonal -
        Returns:
        All series associated with the specified axis types
      • isTransposed

        boolean isTransposed()
        A convenience method used to determine if the plot is transposed or not. For an orthogonal set of axes, this is determined by evaluating the 'Orientation' property. If (orientation == HORIZONTAL), the chart is transposed. NOTE: Manually written
        Returns:
        A boolean indicating if the chart is transposed or not
      • setTransposed

        void setTransposed​(boolean bTransposed)
        A convenience method used to specify if the plot is transposed or not. For an orthogonal set of axes, this is determined by internally setting the 'Orientation' property. If (orientation == HORIZONTAL), the chart is transposed. NOTE: Manually written