xref: /aoo42x/main/offapi/com/sun/star/chart/Diagram.idl (revision 0d3a54ff)

/**************************************************************
 *
 * 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_chart_Diagram_idl__
#define __com_sun_star_chart_Diagram_idl__

#ifndef __com_sun_star_chart_XDiagram_idl__
#include <com/sun/star/chart/XDiagram.idl>
#endif

#ifndef __com_sun_star_chart_XAxisSupplier_idl__
#include <com/sun/star/chart/XAxisSupplier.idl>
#endif

#ifndef __com_sun_star_chart_XDiagramPositioning_idl__
#include <com/sun/star/chart/XDiagramPositioning.idl>
#endif

#ifndef __com_sun_star_chart_XSecondAxisTitleSupplier_idl__
#include <com/sun/star/chart/XSecondAxisTitleSupplier.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_chart_ChartDataRowSource_idl__
#include <com/sun/star/chart/ChartDataRowSource.idl>
#endif

#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** the base service for the diagram of the chart document.

    <p>The diagram is the object that contains the actual plot.</p>

    <p>Different Diagram Types, e.g., <type>PieDiagram</type> or
    <type>LineDiagram</type>, can be instantiated by the
    <type scope="com::sun::star::lang">XMultiServiceFactory</type> of
    the <type>XChartDocument</type>.</p>

 */
published service Diagram
{

    interface com::sun::star::chart::XDiagram;

    /** Provides easier access to the differnet axes and their sub elements.
        @since OpenOffice 3.4
    */
    [optional] interface com::sun::star::chart::XAxisSupplier;

    /** Provides access to the titles of the secondary X axis and Y axis.
        @since OpenOffice 3.0
     */
    [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier;

    /**
    @since OpenOffice 3.3
     */
    [optional] interface com::sun::star::chart::XDiagramPositioning;

    //-------------------------------------------------------------------------

	/** If this property is <TRUE/> the position is calculated by the application automatically.
        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
        to set a concrete position (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
	 */
	[optional, property] boolean AutomaticPosition;

    //-------------------------------------------------------------------------

	/** If this property is <TRUE/> the size is calculated by the application automatically.
        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
        to set a concrete size (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
	 */
	[optional, property] boolean AutomaticSize;

    //-------------------------------------------------------------------------

	interface com::sun::star::beans::XPropertySet;

	//-------------------------------------------------------------------------

    /** If a <type>Diagram</type> may be stored as XML file, this
        service should be supported in order to preserve unparsed XML
        attributes.

	@since OpenOffice 1.1.2
     */
    [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;

    //-------------------------------------------------------------------------

	/** determines if the data for a data row is contained in the
		columns or in the rows of the data array.

        @see ChartDataRowSource
        @see ChartDataArray
	 */
	[property] com::sun::star::chart::ChartDataRowSource DataRowSource;

	//-------------------------------------------------------------------------

	/** specifies how the caption of data points is displayed.

        @see ChartDataCaption
	 */
	[property] long DataCaption;

    //-------------------------------------------------------------------------

    /** specifies how empty or invalid cells in the provided data should be handled when displayed

        @see MissingValueTreatment
	 */
    [optional, property] long MissingValueTreatment;

};

//=============================================================================

}; }; }; };

#endif