1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef com_sun_star_chart2_data_DataSequenceRole_idl 28#define com_sun_star_chart2_data_DataSequenceRole_idl 29 30module com 31{ 32module sun 33{ 34module star 35{ 36module chart2 37{ 38module data 39{ 40 41/** a string that states in what way a <type>DataSequence</type> 42 should be used. If this property is an empty string, no 43 proposition about usage is made. 44 45 <p>The strings can have any value. However some values are 46 predefined and should always be interpreted in the same way.</p> 47 48 <dl> 49 <dt>label</dt> 50 <dd>values are used as a label for a series. Usually, you 51 will have just one cell containing a string.</dd> 52 <dt>values-x</dt> 53 <dd>values are used as x-values in an XY- or bubble 54 diagram</dd> 55 <dt>values-y</dt> 56 <dd>values are used as y-values in an XY-Diagram or as values 57 in a bar, line, etc. chart</dd> 58 <dt>values-z</dt> 59 <dd>values may be used as z-values in a three-dimensional 60 XYZ-Diagram or a surface-chart</dd> 61 <dt>sizes</dt> 62 <dd>values are used as radius of the bubbles in a 63 Bubble-Diagram</dd> 64 <dt>error-bars-x-positive</dt> 65 <dd>values are used as error-information in positive x-direction for 66 displaying error-bars</dd> 67 <dt>error-bars-x-negative</dt> 68 <dd>values are used as error-information in negative x-direction for 69 displaying error-bars</dd> 70 <dt>error-bars-y-positive</dt> 71 <dd>values are used as error-information in positive y-direction for 72 displaying error-bars</dd> 73 <dt>error-bars-y-negative</dt> 74 <dd>values are used as error-information in negative y-direction for 75 displaying error-bars</dd> 76 <dt>categories</dt> 77 <dd>values are used for categories in the diagram</dd> 78 </dl> 79 80 <p>In a candle-stick chart you have the following roles:</p> 81 82 <dl> 83 <dt>values-first</dt> 84 <dd>the first value of a series of values. In a stock-chart this 85 would be the opening course.</dd> 86 <dt>values-last</dt> 87 <dd>the last value of a series of values. In a stock-chart this 88 would be the closing course.</dd> 89 <dt>values-min</dt> 90 <dd>the minimum value of a series of values. In a stock-chart 91 this would be the lowest course that occured during 92 trading.</dd> 93 <dt>values-max</dt> 94 <dd>the maximum value of a series of values. In a stock-chart 95 this would be the highest course that occured during 96 trading.</dd> 97 </dl> 98 */ 99typedef string DataSequenceRole; 100 101} ; // data 102} ; // chart2 103} ; // com 104} ; // sun 105} ; // star 106 107 108#endif 109