summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/chart/ChartAxis.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/chart/ChartAxis.idl268
1 files changed, 268 insertions, 0 deletions
diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl
new file mode 100644
index 000000000..5c5fb8bd3
--- /dev/null
+++ b/offapi/com/sun/star/chart/ChartAxis.idl
@@ -0,0 +1,268 @@
+/* -*- 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 .
+ */
+#ifndef __com_sun_star_chart_ChartAxis_idl__
+#define __com_sun_star_chart_ChartAxis_idl__
+
+#include <com/sun/star/drawing/LineProperties.idl>
+
+#include <com/sun/star/style/CharacterProperties.idl>
+
+#include <com/sun/star/beans/XPropertySet.idl>
+
+#include <com/sun/star/chart/ChartAxisArrangeOrderType.idl>
+#include <com/sun/star/chart/ChartAxisPosition.idl>
+#include <com/sun/star/chart/ChartAxisLabelPosition.idl>
+#include <com/sun/star/chart/ChartAxisMarkPosition.idl>
+#include <com/sun/star/chart/ChartAxisType.idl>
+#include <com/sun/star/chart/TimeIncrement.idl>
+#include <com/sun/star/chart/XAxis.idl>
+#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
+
+
+ module com { module sun { module star { module chart {
+
+
+/** Specifies the axes in a diagram.
+
+ <p>Note: The text properties correlate to all axis description
+ elements, not to just a single text element.</p>
+ */
+published service ChartAxis
+{
+ /** set the properties for the entire axis line as well as for the
+ tick marks.
+ */
+ service com::sun::star::drawing::LineProperties;
+
+ /** set the properties for all text labels of the axis
+ */
+ service com::sun::star::style::CharacterProperties;
+
+ /** If a ChartAxis may be stored as XML element, this
+ service should be supported in order to preserve unparsed XML
+ attributes.
+
+ @since OOo 1.1.2
+ */
+ [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
+
+ /** Access to the sub elements of an axis like title and grids.
+ @since OOo 3.4
+ */
+ [optional] interface com::sun::star::chart::XAxis;
+
+ interface com::sun::star::beans::XPropertySet;
+
+ /** Properties for scaling:
+ */
+
+
+ /** Contains the maximum value for the axis scale.
+ */
+ [optional, property] double Max;
+
+
+ /** Contains the minimum value for the axis scale.
+ */
+ [optional, property] double Min;
+
+
+ /** Contains the distance between the main tick marks.
+ */
+ [optional, property] double StepMain;
+
+
+ /**
+ Contains the number of help intervals within a main interval. E.g. a StepHelpCount of 5 divides
+ the main interval into 5 pieces and thus produces 4 help tick marks.
+ */
+ [optional, property] long StepHelpCount;
+
+
+ /** @deprecated
+ User property StepHelpCount instead
+ Contains the distance between the help tick marks.
+ */
+ [optional, property] double StepHelp;
+
+
+ /** The maximum value of the axis scale is calculated by the chart if
+ this property is `TRUE`.
+ */
+ [optional, property] boolean AutoMax;
+
+
+ /** The minimum value of the axis scale is calculated by the chart if
+ this property is `TRUE`.
+ */
+ [optional, property] boolean AutoMin;
+
+
+ /** The distance between the main tick marks is calculated by the chart
+ if this property is `TRUE`.
+ */
+ [optional, property] boolean AutoStepMain;
+
+
+ /** The number of help intervals within a main interval is calculated by the
+ chart if this property is `TRUE`.
+ */
+ [optional, property] boolean AutoStepHelp;
+
+
+
+ /** Determines if the axis is scaled logarithmically or
+ not (linear).
+ */
+ [optional, property] boolean Logarithmic;
+
+
+ /** determines which type of axis this is, e.g. a date-axis or a category-axis @see ChartAxisType
+ @since OOo 3.4
+ */
+ [optional, property] long AxisType;
+
+
+ /** if the current axis is a date-axis the intervals are chosen as given with TimeIncrement
+ @since OOo 3.4
+ */
+ [optional, maybevoid, property] TimeIncrement TimeIncrement;
+
+
+ /** Determines if the axis orientation is mathematical or reversed.
+ */
+ [optional, property] boolean ReverseDirection;
+
+
+ /** Determines where the axis crosses the other axis.
+ */
+ [optional, property] com::sun::star::chart::ChartAxisPosition CrossoverPosition;
+
+
+ /** Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
+ */
+ [optional, property] double CrossoverValue;
+
+
+ /** Indicates the reference value where bars or areas have their grounding.
+ This property has only an effect when the used ODF file format does not allow for
+ further axis positioning or the axis is a secondary y-axis.
+ */
+ [optional, property] double Origin;
+
+
+ /** The origin is calculated by the chart if this property is `TRUE`.
+ */
+ [optional, property] boolean AutoOrigin;
+
+ /** Properties for interval marks:
+ */
+
+
+ /** Determines the type of the marks.@see ChartAxisMarks
+ */
+ [property] long Marks;
+
+
+ /** Determines the type of the help marks.@see ChartAxisMarks
+ */
+ [property] long HelpMarks;
+
+ /** Determines where the interval marks are placed.
+ */
+ [optional, property] com::sun::star::chart::ChartAxisMarkPosition MarkPosition;
+
+ /** Properties for axes labels:
+ */
+
+
+ /** Determines whether to display text at the axis or not.
+ */
+ [property] boolean DisplayLabels;
+
+
+ /** Contains the type id for the number formatter of the axis.
+
+ @see com::sun::star::util::XNumberFormatter
+ */
+ [property] long NumberFormat;
+
+
+ /** determines whether to use the number format given by the
+ container application, e.g. a spreadsheet document, or from
+ the own property #NumberFormat.
+ */
+ [optional, property] boolean LinkNumberFormatToSource;
+
+
+ /** Determines where the axis labels are placed.
+ */
+ [optional, property] com::sun::star::chart::ChartAxisLabelPosition LabelPosition;
+
+
+ /** Determines the rotation of the text elements
+ (axis description) in 100th degrees.
+ */
+ [property] long TextRotation;
+
+
+ /** The axis description may be arranged in a special order for a
+ better placement.
+ */
+ [property] com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder;
+
+
+ /** Determines if long text is broken into multiple lines.
+ */
+ [property] boolean TextBreak;
+
+
+ /** Determines if certain labels are hidden, if they would otherwise overlap.
+ In this case, the value of this property must be set to `FALSE`.
+ */
+ [property] boolean TextCanOverlap;
+
+ /** Properties related to bar charts:
+ */
+
+
+ /** Determines the overlap of the bars in a bar-type chart.
+
+ <p>The value is given in percent of the width of the bars. The
+ valid range is -100% to +100%. +100% means full overlap, -100%
+ indicates a distance of one bar between 2 neighboring bars.</p>
+ */
+ [property] long Overlap;
+
+
+ /** Specifies the width of the gaps between each set of data points
+ in a bar chart.
+
+ <p>The value is given in percent of the width of a bar; the
+ valid range is 0 to 600%.</p>
+ */
+ [property] long GapWidth;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */