diff options
Diffstat (limited to 'offapi/com/sun/star/chart2/data/DataSequenceRole.idl')
-rw-r--r-- | offapi/com/sun/star/chart2/data/DataSequenceRole.idl | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/offapi/com/sun/star/chart2/data/DataSequenceRole.idl b/offapi/com/sun/star/chart2/data/DataSequenceRole.idl new file mode 100644 index 000000000000..4586faaed304 --- /dev/null +++ b/offapi/com/sun/star/chart2/data/DataSequenceRole.idl @@ -0,0 +1,108 @@ +/************************************************************************* + * + * 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_chart2_data_DataSequenceRole_idl +#define com_sun_star_chart2_data_DataSequenceRole_idl + +module com +{ +module sun +{ +module star +{ +module chart2 +{ +module data +{ + +/** a string that states in what way a <type>DataSequence</type> + should be used. If this property is an empty string, no + proposition about usage is made. + + <p>The strings can have any value. However some values are + predefined and should always be interpreted in the same way.</p> + + <dl> + <dt>label</dt> + <dd>values are used as a label for a series. Usually, you + will have just one cell containing a string.</dd> + <dt>values-x</dt> + <dd>values are used as x-values in an XY- or bubble + diagram</dd> + <dt>values-y</dt> + <dd>values are used as y-values in an XY-Diagram or as values + in a bar, line, etc. chart</dd> + <dt>values-z</dt> + <dd>values may be used as z-values in a three-dimensional + XYZ-Diagram or a surface-chart</dd> + <dt>sizes</dt> + <dd>values are used as radius of the bubbles in a + Bubble-Diagram</dd> + <dt>error-bars-x-positive</dt> + <dd>values are used as error-information in positive x-direction for + displaying error-bars</dd> + <dt>error-bars-x-negative</dt> + <dd>values are used as error-information in negative x-direction for + displaying error-bars</dd> + <dt>error-bars-y-positive</dt> + <dd>values are used as error-information in positive y-direction for + displaying error-bars</dd> + <dt>error-bars-y-negative</dt> + <dd>values are used as error-information in negative y-direction for + displaying error-bars</dd> + <dt>categories</dt> + <dd>values are used for categories in the diagram</dd> + </dl> + + <p>In a candle-stick chart you have the following roles:</p> + + <dl> + <dt>values-first</dt> + <dd>the first value of a series of values. In a stock-chart this + would be the opening course.</dd> + <dt>values-last</dt> + <dd>the last value of a series of values. In a stock-chart this + would be the closing course.</dd> + <dt>values-min</dt> + <dd>the minimum value of a series of values. In a stock-chart + this would be the lowest course that occured during + trading.</dd> + <dt>values-max</dt> + <dd>the maximum value of a series of values. In a stock-chart + this would be the highest course that occured during + trading.</dd> + </dl> + */ +typedef string DataSequenceRole; + +} ; // data +} ; // chart2 +} ; // com +} ; // sun +} ; // star + + +#endif |