libreoffice/offapi/com/sun/star/sheet/DataPilotField.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */


module com {  module sun {  module star {  module sheet {


/** represents a single field in a data pilot table.

    <p>If the data pilot table is based on a spreadsheet cell range, a field
    is represented by a column of the range and is named using the topmost
    cell of the column.</p>
 */
published service DataPilotField
{

    /** provides access to the name of the data pilot field.
     */
    interface com::sun::star::container::XNamed;


//!published service PropertySet
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;


    [optional] interface XDataPilotField;


    [optional] interface XDataPilotFieldGrouping;


    /** specifies the orientation of the field.

        <p>If the orientation of a field has been changed using this property,
        the field will be moved to the last position in the collection of all
        fields with the specified orientation.</p>
     */
    [property] DataPilotFieldOrientation Orientation;


    /** specifies the function used to calculate results for this field.

        <p>For column and row fields, this is the function for subtotals
        (GeneralFunction::NONE means no subtotals).
        For data fields, this is the function shown in the data pilot
        table.</p>
     */
    [property] GeneralFunction Function;


    /** specifies the functions used to calculate subtotals for this field.

        <p>This property is supported by column and row fields only.</p>

        <p>An empty sequence means no subtotals. The same effect can be
        achieved by setting the property #Function to the
        value GeneralFunction::NONE. If the length of the
        sequence is greater than 1, then the sequence MUST NOT contain one of
        the values GeneralFunction::NONE or
        GeneralFunction::AUTO.</p>

        <p>The order of the functions in this sequence is reflected in the
        DataPilot table. Multiple entries of the same function are ignored
        when setting the property.</p>
     */
    [property, optional] sequence<GeneralFunction> Subtotals;

    /** specifies the selected page which is used to filter the data pilot.
     */
    [property, optional] string SelectedPage;


    /** specifies whether to use the selected page to filter the data pilot or
        show all.
     */
    [property, optional] boolean UseSelectedPage;


    /** specifies which hierarchy of the dimension is used.

    @see com::sun::star::sheet::DataPilotSourceHierarchies
     */
    [property, optional] string UsedHierarchy;


    /** specifies whether this field has sorting information.
     */
    [property, optional] boolean HasSortInfo;


    /** controls how the field's items are sorted.
     */
    [property, optional] DataPilotFieldSortInfo SortInfo;


    /** specifies whether this field has layout information.
     */
    [property, optional] boolean HasLayoutInfo;


    /** controls how the field's items are laid out in the result table.
     */
    [property, optional] DataPilotFieldLayoutInfo LayoutInfo;


    /** specifies whether this field has auto show information.
     */
    [property, optional] boolean HasAutoShowInfo;


    /** enables the automatic inclusion of only a number of items with
        the highest or lowest result values.
     */
    [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;


    /** specifies whether this field has a reference.
     */
    [property, optional] boolean HasReference;


    /** controls how the results are shown in relation to a selected
        reference result.
     */
    [property, optional] DataPilotFieldReference Reference;


    /** specifies whether this field is a group field.
     */
    [property, optional] boolean IsGroupField;


    /** contains the grouping information of the DataPilot field.

        <p>By changing the value of this property it is possible to modify the
        grouping settings of this field.</p>
     */
    [property, optional] DataPilotFieldGroupInfo GroupInfo;


    /** specifies whether to show this field also if it is empty or not.
     */
    [property, optional] boolean ShowEmpty;

    /** specifies the function used to calculate results for this field.

        <p>For column and row fields, this is the function for subtotals
        (GeneralFunction2::NONE means no subtotals).
        For data fields, this is the function shown in the data pilot
        table.</p>

        @since LibreOffice 5.3
     */

    [property, optional] short Function2;

    /** specifies the functions used to calculate subtotals for this field.

        <p>This property is supported by column and row fields only.</p>

        <p>An empty sequence means no subtotals. The same effect can be
        achieved by setting the property #Function2 to the
        value GeneralFunction::NONE. If the length of the
        sequence is greater than 1, then the sequence MUST NOT contain one of
        the values GeneralFunction2::NONE or
        GeneralFunction2::AUTO.</p>

        <p>The order of the functions in this sequence is reflected in the
        DataPilot table. Multiple entries of the same function are ignored
        when setting the property.</p>

        @since LibreOffice 5.3
     */
    [property, optional] sequence<short> Subtotals2;
};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */