offapi/com/sun/star/chart/Diagram.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module chart {
  22
  23
  24 /** the base service for the diagram of the chart document.
  25
  26     <p>The diagram is the object that contains the actual plot.</p>
  27
  28     <p>Different Diagram Types, e.g., PieDiagram or
  29     LineDiagram, can be instantiated by the
  30     com::sun::star::lang::XMultiServiceFactory of
  31     the XChartDocument.</p>
  32
  33  */
  34 published service Diagram
  35 {
  36
  37     interface com::sun::star::chart::XDiagram;
  38
  39     /** Provides easier access to the different axes and their sub elements.
  40         @since OOo 3.4
  41     */
  42     [optional] interface com::sun::star::chart::XAxisSupplier;
  43
  44     /** Provides access to the titles of the secondary X axis and Y axis.
  45         @since OOo 3.0
  46      */
  47     [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier;
  48
  49     /**
  50     @since OOo 3.3
  51      */
  52     [optional] interface com::sun::star::chart::XDiagramPositioning;
  53
  54
  55     /** If this property is `TRUE` the position is calculated by the application automatically.
  56         Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape
  57         to set a concrete position (note com::sun::star::chart::XDiagram is derived from com::sun::star::drawing::XShape).
  58      */
  59     [optional, property] boolean AutomaticPosition;
  60
  61
  62     /** If this property is `TRUE` the size is calculated by the application automatically.
  63         Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape
  64         to set a concrete size (note com::sun::star::chart::XDiagram is derived from com::sun::star::drawing::XShape).
  65      */
  66     [optional, property] boolean AutomaticSize;
  67
  68
  69     interface com::sun::star::beans::XPropertySet;
  70
  71
  72     /** If a Diagram may be stored as XML file, this
  73         service should be supported in order to preserve unparsed XML
  74         attributes.
  75
  76     @since OOo 1.1.2
  77      */
  78     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  79
  80
  81     /** determines if the data for a data row is contained in the
  82         columns or in the rows of the data array.
  83
  84         @see ChartDataRowSource
  85         @see ChartDataArray
  86      */
  87     [property] com::sun::star::chart::ChartDataRowSource DataRowSource;
  88
  89
  90     /** specifies how the caption of data points is displayed.
  91
  92         @see ChartDataCaption
  93      */
  94     [property] long DataCaption;
  95
  96
  97     /** specifies how empty or invalid cells in the provided data should be handled when displayed
  98
  99         @see MissingValueTreatment
 100      */
 101     [optional, property] long MissingValueTreatment;
 102
 103 };
 104
 105
 106 }; }; }; };
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */