chart2/source/view/inc/VDataSeries.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: VDataSeries.hxx,v $
  10  * $Revision: 1.21.8.2 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _CHART2_VIEW_DATASERIES_HXX
  31 #define _CHART2_VIEW_DATASERIES_HXX
  32
  33 #include "PropertyMapper.hxx"
  34
  35 #include <vector>
  36 //for auto_ptr
  37 #include <memory>
  38 #include <com/sun/star/chart2/DataPointLabel.hpp>
  39 #include <com/sun/star/chart2/Symbol.hpp>
  40 #include <com/sun/star/chart2/StackingDirection.hpp>
  41 #include <com/sun/star/chart2/data/XLabeledDataSequence.hpp>
  42 #include <com/sun/star/chart2/XChartType.hpp>
  43 #include <com/sun/star/chart2/XDataSeries.hpp>
  44 #include <com/sun/star/drawing/HomogenMatrix.hpp>
  45 #include <com/sun/star/drawing/PolyPolygonShape3D.hpp>
  46 #include <com/sun/star/drawing/XShape.hpp>
  47 #include <com/sun/star/drawing/XShapes.hpp>
  48 #include <cppuhelper/weakref.hxx>
  49
  50 //.............................................................................
  51 namespace chart
  52 {
  53 //.............................................................................
  54
  55 //-----------------------------------------------------------------------------
  56 /**
  57 */
  58 class VDataSequence
  59 {
  60 public:
  61     void init( const ::com::sun::star::uno::Reference<
  62         ::com::sun::star::chart2::data::XDataSequence >& xModel );
  63     bool is() const;
  64     void clear();
  65     double getValue( sal_Int32 index ) const;
  66     sal_Int32 detectNumberFormatKey( sal_Int32 index ) const;
  67     sal_Int32 getLength() const;
  68
  69
  70     ::com::sun::star::uno::Reference<
  71         ::com::sun::star::chart2::data::XDataSequence >     Model;
  72
  73     mutable ::com::sun::star::uno::Sequence< double > Doubles;
  74 };
  75
  76 class VDataSeries
  77 {
  78 public:
  79     VDataSeries( const ::com::sun::star::uno::Reference<
  80         ::com::sun::star::chart2::XDataSeries >& xDataSeries );
  81     virtual ~VDataSeries();
  82
  83     ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries >
  84         getModel() const;
  85
  86     void setCategoryXAxis();
  87     void setParticle( const rtl::OUString& rSeriesParticle );
  88     void setGlobalSeriesIndex( sal_Int32 nGlobalSeriesIndex );
  89     void setPageReferenceSize( const ::com::sun::star::awt::Size & rPageRefSize );
  90
  91     sal_Int32   getTotalPointCount() const;
  92     double      getXValue( sal_Int32 index ) const;
  93     double      getYValue( sal_Int32 index ) const;
  94
  95     double      getY_Min( sal_Int32 index ) const;
  96     double      getY_Max( sal_Int32 index ) const;
  97     double      getY_First( sal_Int32 index ) const;
  98     double      getY_Last( sal_Int32 index ) const;
  99
 100     double      getBubble_Size( sal_Int32 index ) const;
 101
 102     double      getMinimumofAllDifferentYValues( sal_Int32 index ) const;
 103     double      getMaximumofAllDifferentYValues( sal_Int32 index ) const;
 104
 105     ::com::sun::star::uno::Sequence< double > getAllX() const;
 106     ::com::sun::star::uno::Sequence< double > getAllY() const;
 107
 108     double getYMeanValue() const;
 109
 110     bool        hasExplicitNumberFormat( sal_Int32 nPointIndex, bool bForPercentage ) const;
 111     sal_Int32   getExplicitNumberFormat( sal_Int32 nPointIndex, bool bForPercentage ) const;
 112     sal_Int32   detectNumberFormatKey( sal_Int32 nPointIndex ) const;
 113     bool        shouldLabelNumberFormatKeyBeDetectedFromYAxis() const;
 114
 115     sal_Int32   getLabelPlacement( sal_Int32 nPointIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartType >& xChartType
 116                         , sal_Int32 nDimensionCount, sal_Bool bSwapXAndY ) const;
 117
 118     ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
 119                         getPropertiesOfPoint( sal_Int32 index ) const;
 120
 121     ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
 122                         getPropertiesOfSeries() const;
 123
 124     ::com::sun::star::chart2::Symbol*
 125                         getSymbolProperties( sal_Int32 index ) const;
 126
 127     ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
 128                         getYErrorBarProperties( sal_Int32 index ) const;
 129
 130     bool hasPointOwnColor( sal_Int32 index ) const;
 131
 132     ::com::sun::star::chart2::StackingDirection getStackingDirection() const;
 133     sal_Int32 getAttachedAxisIndex() const;
 134     void setAttachedAxisIndex( sal_Int32 nAttachedAxisIndex );
 135
 136     void doSortByXValues();
 137
 138     void setConnectBars( sal_Bool bConnectBars );
 139     sal_Bool getConnectBars() const;
 140
 141     void setGroupBarsPerAxis( sal_Bool bGroupBarsPerAxis );
 142     sal_Bool getGroupBarsPerAxis() const;
 143
 144     void setStartingAngle( sal_Int32 nStartingAngle );
 145     sal_Int32 getStartingAngle() const;
 146
 147     void setRoleOfSequenceForDataLabelNumberFormatDetection( const rtl::OUString& rRole );
 148
 149     //this is only temporarily here for area chart:
 150     ::com::sun::star::drawing::PolyPolygonShape3D       m_aPolyPolygonShape3D;
 151     sal_Int32   m_nPolygonIndex;
 152     double m_fLogicMinX;
 153     double m_fLogicMaxX;
 154     //
 155     //this is here for deep stacking:
 156     double m_fLogicZPos;//from 0 to series count -1
 157     //
 158
 159     rtl::OUString       getCID() const;
 160     rtl::OUString       getSeriesParticle() const;
 161     rtl::OUString       getPointCID_Stub() const;
 162     rtl::OUString       getErrorBarsCID() const;
 163     rtl::OUString       getLabelsCID() const;
 164     rtl::OUString       getLabelCID_Stub() const;
 165     rtl::OUString       getDataCurveCID( sal_Int32 nCurveIndex, bool bAverageLine ) const;
 166
 167     ::com::sun::star::chart2::DataPointLabel*
 168                         getDataPointLabelIfLabel( sal_Int32 index ) const;
 169     bool    getTextLabelMultiPropertyLists( sal_Int32 index, tNameSequence*& pPropNames, tAnySequence*& pPropValues ) const;
 170
 171     rtl::OUString       getDataCurveEquationCID( sal_Int32 nCurveIndex ) const;
 172     bool    isAttributedDataPoint( sal_Int32 index ) const;
 173
 174     bool    isVaryColorsByPoint() const;
 175
 176     void releaseShapes();
 177
 178     void setMissingValueTreatment( sal_Int32 nMissingValueTreatment );
 179     sal_Int32 getMissingValueTreatment() const;
 180
 181 private: //methods
 182     ::com::sun::star::chart2::DataPointLabel*
 183                         getDataPointLabel( sal_Int32 index ) const;
 184     void adaptPointCache( sal_Int32 nNewPointIndex ) const;
 185
 186 public: //member
 187     ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShapes > m_xGroupShape;
 188     ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShapes > m_xLabelsGroupShape;
 189     ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShapes > m_xErrorBarsGroupShape;
 190
 191     //the following group shapes will be created as children of m_xGroupShape on demand
 192     //they can be used to assure that some parts of a series shape are always in front of others (e.g. symbols in front of lines)
 193     ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShapes > m_xFrontSubGroupShape;
 194     ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShapes > m_xBackSubGroupShape;
 195
 196 private: //member
 197     ::com::sun::star::uno::Reference<
 198             ::com::sun::star::chart2::XDataSeries >       m_xDataSeries;
 199     ::com::sun::star::uno::Sequence<
 200         ::com::sun::star::uno::Reference<
 201             ::com::sun::star::chart2::data::XLabeledDataSequence > >   m_aDataSequences;
 202
 203     //all points given by the model data (here are not only the visible points meant)
 204     sal_Int32       m_nPointCount;
 205
 206     VDataSequence   m_aValues_X;
 207     VDataSequence   m_aValues_Y;
 208     VDataSequence   m_aValues_Z;
 209
 210     VDataSequence   m_aValues_Y_Min;
 211     VDataSequence   m_aValues_Y_Max;
 212     VDataSequence   m_aValues_Y_First;
 213     VDataSequence   m_aValues_Y_Last;
 214
 215     VDataSequence   m_aValues_Bubble_Size;
 216
 217     VDataSequence*  m_pValueSequenceForDataLabelNumberFormatDetection;
 218
 219     mutable double m_fYMeanValue;
 220
 221     ::com::sun::star::uno::Sequence< sal_Int32 >    m_aAttributedDataPointIndexList;
 222
 223     ::com::sun::star::chart2::StackingDirection     m_eStackingDirection;
 224
 225     sal_Int32               m_nAxisIndex;//indicates wether this is attached to a main or secondary axis
 226
 227     sal_Bool                m_bConnectBars;
 228
 229     sal_Bool                m_bGroupBarsPerAxis;
 230
 231     sal_Int32               m_nStartingAngle;
 232
 233     rtl::OUString           m_aSeriesParticle;
 234     rtl::OUString           m_aCID;
 235     rtl::OUString           m_aPointCID_Stub;
 236     rtl::OUString           m_aLabelCID_Stub;
 237
 238     sal_Int32               m_nGlobalSeriesIndex;
 239
 240     //some cached values for data labels as they are very expensive
 241     mutable ::std::auto_ptr< ::com::sun::star::chart2::DataPointLabel >
 242                                                     m_apLabel_Series;
 243     mutable ::std::auto_ptr< tNameSequence >        m_apLabelPropNames_Series;
 244     mutable ::std::auto_ptr< tAnySequence >         m_apLabelPropValues_Series;
 245     mutable ::std::auto_ptr< ::com::sun::star::chart2::Symbol >
 246                                                     m_apSymbolProperties_Series;
 247
 248     mutable ::std::auto_ptr< ::com::sun::star::chart2::DataPointLabel >
 249                                                     m_apLabel_AttributedPoint;
 250     mutable ::std::auto_ptr< tNameSequence >        m_apLabelPropNames_AttributedPoint;
 251     mutable ::std::auto_ptr< tAnySequence >         m_apLabelPropValues_AttributedPoint;
 252     mutable ::std::auto_ptr< ::com::sun::star::chart2::Symbol >
 253                                                     m_apSymbolProperties_AttributedPoint;
 254     mutable ::std::auto_ptr< ::com::sun::star::chart2::Symbol >
 255                                                     m_apSymbolProperties_InvisibleSymbolForSelection;
 256     mutable sal_Int32                               m_nCurrentAttributedPoint;
 257     ::com::sun::star::awt::Size                     m_aReferenceSize;
 258     //
 259
 260     sal_Int32   m_nMissingValueTreatment;
 261     bool        m_bAllowPercentValueInDataLabel;
 262 };
 263
 264 //.............................................................................
 265 } //namespace chart
 266 //.............................................................................
 267 #endif