xref: /aoo41x/main/offapi/com/sun/star/chart2/XDiagram.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef com_sun_star_chart2_XDiagram_idl
#define com_sun_star_chart2_XDiagram_idl

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/beans/PropertyValue.idl>
#include <com/sun/star/chart2/XLegend.idl>
#include <com/sun/star/chart2/XColorScheme.idl>
#include <com/sun/star/chart2/data/XDataSource.idl>
#include <com/sun/star/chart2/data/XLabeledDataSequence.idl>

module com
{
module sun
{
module star
{
module chart2
{

interface XDiagram : ::com::sun::star::uno::XInterface
{
    /** returns the property set that determines the visual appearance
        of the wall.

        <p>The wall is the area behind the union of all
        coordinate systems used in a diagram.</p>
     */
    com::sun::star::beans::XPropertySet getWall();

    /** returns the property set that determines the visual appearance
        of the floor if any.

        <p>The floor is the bottom of a 3D diagram.
        For a 2D diagram NULL is returned.</p>
     */
    com::sun::star::beans::XPropertySet getFloor();

    /** returns the legend, which may represent data series and other
        information about a diagram in a separate box.
     */
    XLegend getLegend();

    /** sets a new legend.
     */
    void setLegend( [in] XLegend xLegend );

    /** returns an <type>XColorScheme</type> that defines the default
        colors for data series (or data points) in the diagram.
     */
    XColorScheme   getDefaultColorScheme();

    /** sets an <type>XColorScheme</type> that defines the default
        colors for data series (or data points) in the diagram.
     */
    void setDefaultColorScheme( [in] XColorScheme xColorScheme );

    /** sets new data to the diagram.

        @param xDataSource
            This data source will be interpreted in a chart-type
            specific way and the <type>DataSeries</type> found in
            <code>xDiagram</code> will be adapted to the new data.
            Missing data series will be created and unused ones will
            be deleted.

        @param aArguments
            Arguments tells how to slice the given data.

            <p>For standard parameters that may be used, see the
            service <type>StandardDiagramCreationParameters</type>.
            </p>
     */
    void setDiagramData( [in] data::XDataSource xDataSource,
        [in] sequence< com::sun::star::beans::PropertyValue > aArguments );
};

} ; // chart2
} ; // com
} ; // sun
} ; // star

#endif