xref: /aoo42x/main/offapi/com/sun/star/chart2/Diagram.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef com_sun_star_chart_Diagram_idl
#define com_sun_star_chart_Diagram_idl

#ifndef com_sun_star_chart2_XDiagram_idl__
#include <com/sun/star/chart2/XDiagram.idl>
#endif

#include <com/sun/star/chart2/XCoordinateSystemContainer.idl>
#include <com/sun/star/chart2/XTitled.idl>
#include <com/sun/star/chart2/RelativePosition.idl>
#include <com/sun/star/layout/RelativeSize.idl>
#include <com/sun/star/chart/X3DDefaultSetter.idl>

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

/**
 */
service Diagram
{
    /**
     */
    interface ::com::sun::star::chart2::XDiagram;

    /**
     */
    interface ::com::sun::star::chart2::XCoordinateSystemContainer;

    /** gives access to the sub title of a chart document
     */
    interface  XTitled;

    /** makes it easy to set suiteable defaults for illumination and rotation for 3D charts
     */
    [optional] interface ::com::sun::star::chart::X3DDefaultSetter;

    /** The position is as a relative position on the page.

        <p>If a relative position is given the diagam is not automatically placed,
        but instead is placed relative on the page.</p>
     */
    [property, maybevoid] ::com::sun::star::chart2::RelativePosition RelativePosition;

    /** The size of the diagram as relative size of the page size.
     */
    [property] ::com::sun::star::layout::RelativeSize RelativeSize;

    /** The attributes RelativePosition and RelativeSize should be used for the inner coordinate region without axis labels and without data labels.
     */
    [optional, property] boolean                    PosSizeExcludeLabels;

    /** Sort data points by x values for rendering
     */
    [optional, property] boolean                    SortByXValues;

    /** Draw connection lines for stacked bar charts.
     */
    [optional, property] boolean                    ConnectBars;

    /** If bars of a bar or column chart are attached to different
        axis, this property determines how to display those.  If
        <TRUE/>, the bars are grouped together in one block for each
        axis, thus they are painted one group over the other.

        <p>If <FALSE/>, the bars are displayed side-by-side, as if
        they were all attached to the same axis.</p>

        <p>If all data series of a bar or column chart are attached to
        only one axis, this property has no effect.</p>
    */
    [optional, property] boolean                    GroupBarsPerAxis;

    /** Starting angle in degrees for pie charts and doughnut charts.
     */
    [optional, property] long                       StartingAngle;

    [optional, property] boolean                    RightAngledAxes;

    /** Perspective of 3D charts ( [0,100] ).
     */
    [optional, property] long                       Perspective;

    /** Horizontal rotation of 3D charts in degrees ( ]-180,180] ).
     */
    [optional, property] long                       RotationHorizontal;

    /** Vertical rotation of 3D charts in degrees ( ]-180,180] ).
     */
    [optional, property] long                       RotationVertical;

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

        @see ::com::sun::star::chart::MissingValueTreatment
	 */
    [optional, property] long                       MissingValueTreatment;
};

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

#endif