chart2/source/view/inc/VDataSeries.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #pragma once
  20
  21 #include "PropertyMapper.hxx"
  22
  23 #include <com/sun/star/chart2/DataPointLabel.hpp>
  24 #include <com/sun/star/chart2/StackingDirection.hpp>
  25 #include <com/sun/star/chart2/Symbol.hpp>
  26 #include <com/sun/star/drawing/Position3D.hpp>
  27 #include <com/sun/star/awt/Size.hpp>
  28 #include <com/sun/star/awt/Point.hpp>
  29 #include <rtl/ref.hxx>
  30 #include <svx/unoshape.hxx>
  31
  32 #include <memory>
  33 #include <map>
  34
  35 namespace com::sun::star::beans { class XPropertySet; }
  36 namespace com::sun::star::chart2 { class XChartType; }
  37 namespace com::sun::star::chart2 { class XDataSeries; }
  38 namespace com::sun::star::chart2::data { class XDataSequence; }
  39 namespace com::sun::star::drawing { class XShapes; }
  40
  41 namespace chart
  42 {
  43 class ChartType;
  44 class DataSeries;
  45
  46 class VDataSequence
  47 {
  48 public:
  49     void init( const css::uno::Reference<css::chart2::data::XDataSequence>& xModel );
  50     bool is() const;
  51     void clear();
  52     double getValue( sal_Int32 index ) const;
  53     sal_Int32 detectNumberFormatKey( sal_Int32 index ) const;
  54     sal_Int32 getLength() const;
  55
  56     css::uno::Reference<css::chart2::data::XDataSequence> m_xModel;
  57     mutable css::uno::Sequence<double> m_aValues;
  58 };
  59
  60 class VDataSeries final
  61 {
  62 public:
  63     VDataSeries( const rtl::Reference<::chart::DataSeries>& xDataSeries );
  64
  65     ~VDataSeries();
  66
  67     VDataSeries(const VDataSeries&) = delete;
  68     const VDataSeries& operator=(const VDataSeries&) = delete;
  69
  70     const rtl::Reference<::chart::DataSeries>& getModel() const;
  71
  72     void setCategoryXAxis();
  73     void setXValues( const css::uno::Reference<css::chart2::data::XDataSequence>& xValues );
  74     void setXValuesIfNone( const css::uno::Reference<css::chart2::data::XDataSequence>& xValues );
  75     void setParticle( const OUString& rSeriesParticle );
  76     void setGlobalSeriesIndex( sal_Int32 nGlobalSeriesIndex );
  77     void setPageReferenceSize( const css::awt::Size & rPageRefSize );
  78
  79     sal_Int32   getTotalPointCount() const { return m_nPointCount;}
  80     double      getXValue( sal_Int32 index ) const;
  81     double      getYValue( sal_Int32 index ) const;
  82
  83     void        getMinMaxXValue( double& fMin, double& fMax ) const;
  84
  85     double      getY_Min( sal_Int32 index ) const;
  86     double      getY_Max( sal_Int32 index ) const;
  87     double      getY_First( sal_Int32 index ) const;
  88     double      getY_Last( sal_Int32 index ) const;
  89
  90     double      getBubble_Size( sal_Int32 index ) const;
  91
  92     double      getMinimumofAllDifferentYValues( sal_Int32 index ) const;
  93     double      getMaximumofAllDifferentYValues( sal_Int32 index ) const;
  94
  95     double      getValueByProperty( sal_Int32 index, const OUString& rPropName ) const;
  96
  97     bool        hasPropertyMapping( const OUString& rPropName ) const;
  98
  99     css::uno::Sequence< double > const & getAllX() const;
 100     css::uno::Sequence< double > const & getAllY() const;
 101
 102     double getXMeanValue() const;
 103     double getYMeanValue() const;
 104
 105     bool        hasExplicitNumberFormat( sal_Int32 nPointIndex, bool bForPercentage ) const;
 106     sal_Int32   getExplicitNumberFormat( sal_Int32 nPointIndex, bool bForPercentage ) const;
 107     sal_Int32   detectNumberFormatKey( sal_Int32 nPointIndex ) const;
 108
 109     sal_Int32 getLabelPlacement(
 110         sal_Int32 nPointIndex, const rtl::Reference<::chart::ChartType>& xChartType,
 111         bool bSwapXAndY ) const;
 112
 113     css::awt::Point getLabelPosition( css::awt::Point aTextShapePos, sal_Int32 nPointIndex ) const;
 114     bool isLabelCustomPos( sal_Int32 nPointIndex ) const;
 115     css::awt::Size getLabelCustomSize(sal_Int32 nPointIndex) const;
 116
 117     css::uno::Reference<css::beans::XPropertySet> getPropertiesOfPoint( sal_Int32 index ) const;
 118
 119     const css::uno::Reference<css::beans::XPropertySet> & getPropertiesOfSeries() const;
 120
 121     css::chart2::Symbol* getSymbolProperties( sal_Int32 index ) const;
 122
 123     css::uno::Reference<css::beans::XPropertySet> getXErrorBarProperties( sal_Int32 index ) const;
 124
 125     css::uno::Reference<css::beans::XPropertySet> getYErrorBarProperties( sal_Int32 index ) const;
 126
 127     bool hasPointOwnColor( sal_Int32 index ) const;
 128
 129     css::chart2::StackingDirection getStackingDirection() const;
 130     sal_Int32 getAttachedAxisIndex() const;
 131     void setAttachedAxisIndex( sal_Int32 nAttachedAxisIndex );
 132
 133     void doSortByXValues();
 134
 135     void setConnectBars( bool bConnectBars );
 136     bool getConnectBars() const;
 137
 138     void setGroupBarsPerAxis( bool bGroupBarsPerAxis );
 139     bool getGroupBarsPerAxis() const;
 140
 141     void setStartingAngle( sal_Int32 nStartingAngle );
 142     sal_Int32 getStartingAngle() const;
 143
 144     void setRoleOfSequenceForDataLabelNumberFormatDetection( std::u16string_view rRole );
 145
 146     //this is only temporarily here for area chart:
 147     std::vector<std::vector<css::drawing::Position3D>> m_aPolyPolygonShape3D;
 148     sal_Int32   m_nPolygonIndex;
 149     double m_fLogicMinX;
 150     double m_fLogicMaxX;
 151
 152     //this is here for deep stacking:
 153     double m_fLogicZPos;//from 0 to series count -1
 154
 155     const OUString& getCID() const { return m_aCID;}
 156     const OUString& getSeriesParticle() const { return m_aSeriesParticle;}
 157     const OUString& getPointCID_Stub() const { return m_aPointCID_Stub;}
 158     OUString       getErrorBarsCID( bool bYError ) const;
 159     OUString       getLabelsCID() const;
 160     const OUString& getLabelCID_Stub() const { return m_aLabelCID_Stub;}
 161     OUString       getDataCurveCID( sal_Int32 nCurveIndex, bool bAverageLine ) const;
 162
 163     css::chart2::DataPointLabel* getDataPointLabelIfLabel( sal_Int32 index ) const;
 164     bool    getTextLabelMultiPropertyLists( sal_Int32 index, tNameSequence*& pPropNames, tAnySequence*& pPropValues ) const;
 165
 166     OUString       getDataCurveEquationCID( sal_Int32 nCurveIndex ) const;
 167     bool    isAttributedDataPoint( sal_Int32 index ) const;
 168
 169     bool    isVaryColorsByPoint() const;
 170
 171     void releaseShapes();
 172
 173     void setMissingValueTreatment( sal_Int32 nMissingValueTreatment );
 174     sal_Int32 getMissingValueTreatment() const;
 175
 176     void setOldTimeBased( VDataSeries* pOldSeries, double nPercent );
 177     VDataSeries* createCopyForTimeBased() const;
 178
 179 private: //methods
 180     css::chart2::DataPointLabel* getDataPointLabel( sal_Int32 index ) const;
 181     void adaptPointCache( sal_Int32 nNewPointIndex ) const;
 182
 183     // for copies for time based charting
 184     VDataSeries();
 185
 186 public: //member
 187     rtl::Reference<SvxShapeGroupAnyD> m_xGroupShape;
 188     rtl::Reference<SvxShapeGroup> m_xLabelsGroupShape;
 189     rtl::Reference<SvxShapeGroupAnyD> m_xErrorXBarsGroupShape;
 190     rtl::Reference<SvxShapeGroupAnyD> m_xErrorYBarsGroupShape;
 191
 192     //the following group shapes will be created as children of m_xGroupShape on demand
 193     //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)
 194     rtl::Reference<SvxShapeGroupAnyD> m_xFrontSubGroupShape;
 195     rtl::Reference<SvxShapeGroupAnyD> m_xBackSubGroupShape;
 196
 197 private: //member
 198     rtl::Reference<::chart::DataSeries> m_xDataSeries;
 199     css::uno::Reference<css::beans::XPropertySet> m_xDataSeriesProps; // cached
 200
 201     //all points given by the model data (here are not only the visible points meant)
 202     sal_Int32       m_nPointCount;
 203
 204     VDataSequence   m_aValues_X;
 205     VDataSequence   m_aValues_Y;
 206     VDataSequence   m_aValues_Z;
 207
 208     VDataSequence   m_aValues_Y_Min;
 209     VDataSequence   m_aValues_Y_Max;
 210     VDataSequence   m_aValues_Y_First;
 211     VDataSequence   m_aValues_Y_Last;
 212
 213     VDataSequence   m_aValues_Bubble_Size;
 214
 215     VDataSequence*  m_pValueSequenceForDataLabelNumberFormatDetection;
 216
 217     std::map<OUString, VDataSequence> m_PropertyMap;
 218
 219     mutable double m_fXMeanValue;
 220     mutable double m_fYMeanValue;
 221
 222     css::uno::Sequence<sal_Int32>    m_aAttributedDataPointIndexList;
 223
 224     css::chart2::StackingDirection     m_eStackingDirection;
 225
 226     sal_Int32               m_nAxisIndex;//indicates whether this is attached to a main or secondary axis
 227
 228     bool                m_bConnectBars;
 229
 230     bool                m_bGroupBarsPerAxis;
 231
 232     sal_Int32               m_nStartingAngle;
 233
 234     OUString           m_aSeriesParticle;
 235     OUString           m_aCID;
 236     OUString           m_aPointCID_Stub;
 237     OUString           m_aLabelCID_Stub;
 238
 239     sal_Int32               m_nGlobalSeriesIndex;
 240
 241     //some cached values for data labels as they are very expensive
 242     mutable std::optional<css::chart2::DataPointLabel>
 243                                                   m_oLabel_Series;
 244     mutable std::optional<tNameSequence>          m_oLabelPropNames_Series;
 245     mutable std::optional<tAnySequence>           m_oLabelPropValues_Series;
 246     mutable std::optional<css::chart2::Symbol>    m_oSymbolProperties_Series;
 247
 248     mutable std::optional<css::chart2::DataPointLabel>
 249                                                   m_oLabel_AttributedPoint;
 250     mutable std::optional<tNameSequence>          m_oLabelPropNames_AttributedPoint;
 251     mutable std::optional<tAnySequence>           m_oLabelPropValues_AttributedPoint;
 252     mutable std::optional<css::chart2::Symbol>    m_oSymbolProperties_AttributedPoint;
 253     mutable std::optional<css::chart2::Symbol>    m_oSymbolProperties_InvisibleSymbolForSelection;
 254     mutable sal_Int32                             m_nCurrentAttributedPoint;
 255     css::awt::Size                     m_aReferenceSize;
 256
 257     sal_Int32   m_nMissingValueTreatment;
 258     bool        m_bAllowPercentValueInDataLabel;
 259
 260     // for time based charting
 261     VDataSeries* mpOldSeries;
 262     double mnPercent;
 263 };
 264
 265 } //namespace chart
 266
 267 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */