oox/source/drawingml/chart/chartspaceconverter.cxx

   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
  20 #include <drawingml/chart/chartspaceconverter.hxx>
  21
  22 #include <com/sun/star/chart/MissingValueTreatment.hpp>
  23 #include <com/sun/star/chart/XChartDocument.hpp>
  24 #include <com/sun/star/chart2/XChartDocument.hpp>
  25 #include <com/sun/star/chart2/XChartType.hpp>
  26 #include <com/sun/star/chart2/XChartTypeContainer.hpp>
  27 #include <com/sun/star/chart2/XCoordinateSystemContainer.hpp>
  28 #include <com/sun/star/chart2/XDataSeriesContainer.hpp>
  29 #include <com/sun/star/chart2/XTitled.hpp>
  30 #include <com/sun/star/drawing/XDrawPageSupplier.hpp>
  31 #include <oox/core/xmlfilterbase.hxx>
  32 #include <oox/drawingml/chart/chartconverter.hxx>
  33 #include <oox/token/properties.hxx>
  34 #include <oox/token/tokens.hxx>
  35 #include <drawingml/chart/chartdrawingfragment.hxx>
  36 #include <drawingml/chart/chartspacemodel.hxx>
  37 #include <drawingml/chart/plotareaconverter.hxx>
  38 #include <drawingml/chart/titleconverter.hxx>
  39 #include <ooxresid.hxx>
  40 #include <strings.hrc>
  41 #include <drawingml/textbody.hxx>
  42
  43 using namespace ::com::sun::star;
  44 using ::com::sun::star::uno::Reference;
  45 using ::com::sun::star::uno::Exception;
  46 using ::com::sun::star::uno::UNO_QUERY;
  47 using ::com::sun::star::uno::UNO_QUERY_THROW;
  48 using ::com::sun::star::uno::Any;
  49 using ::com::sun::star::drawing::XDrawPageSupplier;
  50 using ::com::sun::star::drawing::XShapes;
  51 using ::com::sun::star::chart2::XDiagram;
  52 using ::com::sun::star::chart2::XTitled;
  53
  54 namespace oox::drawingml::chart {
  55
  56 using namespace ::com::sun::star::awt;
  57 using namespace ::com::sun::star::chart2;
  58 using namespace ::com::sun::star::chart2::data;
  59 using namespace ::com::sun::star::drawing;
  60 using namespace ::com::sun::star::uno;
  61
  62 ChartSpaceConverter::ChartSpaceConverter( const ConverterRoot& rParent, ChartSpaceModel& rModel ) :
  63     ConverterBase< ChartSpaceModel >( rParent, rModel )
  64 {
  65 }
  66
  67 ChartSpaceConverter::~ChartSpaceConverter()
  68 {
  69 }
  70
  71 // Formulas with no numeric values and strings are zeroes in OOXML line charts also in the mode DispBlanksAs=gap,
  72 // unlike in OpenDocument LEAVE_GAP mode. As a workaround, we will use the OpenDocument mode USE_ZERO, if the OOXML
  73 // line chart has got formulas with no numeric values and strings, but it doesn't have empty cells, showing the
  74 // same chart as in MSO. (Empty cells need gaps, so in that case, we cannot use this workaround).
  75 static bool lcl_useWorkaroundForNoGapInOOXML( Reference< chart2::XChartDocument > const & xChartDoc)
  76 {
  77     Reference <chart2::XDiagram > xDiagram = xChartDoc->getFirstDiagram();
  78     if ( !xDiagram.is() )
  79         return false;
  80
  81     Reference< chart2::XCoordinateSystemContainer > xCooSysContainer( xDiagram, UNO_QUERY_THROW );
  82
  83     Sequence< Reference< chart2::XCoordinateSystem > > xCooSysSequence( xCooSysContainer->getCoordinateSystems());
  84     if ( !xCooSysSequence.hasElements() )
  85         return false;
  86
  87     Reference< chart2::XChartTypeContainer > xChartTypeContainer( xCooSysSequence[0], UNO_QUERY_THROW );
  88
  89     Sequence< Reference< chart2::XChartType > > xChartTypeSequence( xChartTypeContainer->getChartTypes() );
  90     if ( !xChartTypeSequence.hasElements() )
  91         return false;
  92
  93     const Reference<chart2::XChartType>& xCT = xChartTypeSequence[0];
  94
  95     if ( xCT->getChartType() != "com.sun.star.chart2.LineChartType" )
  96         return false;
  97
  98     Reference<chart2::XDataSeriesContainer> xDSCont(xCT, uno::UNO_QUERY);
  99
 100     if (!xDSCont.is())
 101         return false;
 102
 103     const Sequence<uno::Reference<chart2::XDataSeries> > aDataSeriesSeq = xDSCont->getDataSeries();
 104
 105     bool bHasNoGapBlankValue = false;
 106     bool bHasEmptyCell = false;
 107
 108     for (const auto& rDataSeries : aDataSeriesSeq)
 109     {
 110         uno::Reference<chart2::data::XDataSource> xDSrc(rDataSeries, uno::UNO_QUERY);
 111         if (!xDSrc.is())
 112             return false;
 113
 114         const uno::Sequence<Reference<chart2::data::XLabeledDataSequence> > aDataSeqs = xDSrc->getDataSequences();
 115         for (const auto& rDataSeq : aDataSeqs)
 116         {
 117             Reference<chart2::data::XDataSequence> xValues = rDataSeq->getValues();
 118             if(!xValues.is())
 119                 return false;
 120             Reference<beans::XPropertySet> xPropSet(xValues, uno::UNO_QUERY);
 121             if (!xPropSet.is())
 122                 continue;
 123
 124             OUString aRoleName;
 125             xPropSet->getPropertyValue(u"Role"_ustr) >>= aRoleName;
 126             if (aRoleName == "values-y")
 127             {
 128                 const uno::Sequence<uno::Any> aData = xValues->getData();
 129                 for (const auto& rVal : aData)
 130                 {
 131                     double fVal;
 132                     OUString sStr;
 133                     if (rVal >>= fVal)
 134                         continue;
 135                     else if (rVal >>= sStr)
 136                         bHasNoGapBlankValue = true;
 137                     else
 138                         bHasEmptyCell = true;
 139                 }
 140             }
 141         }
 142     }
 143
 144     return bHasNoGapBlankValue && !bHasEmptyCell;
 145 }
 146
 147 void ChartSpaceConverter::convertFromModel( const Reference< XShapes >& rxExternalPage, const awt::Point& rChartPos )
 148 {
 149     /*  create data provider (virtual function in the ChartConverter class,
 150         derived converters may create an external data provider) */
 151     getChartConverter().createDataProvider( getChartDocument() );
 152
 153     // formatting of the chart background.  The default fill style varies with applications.
 154     PropertySet aBackPropSet( getChartDocument()->getPageBackground() );
 155     getFormatter().convertFrameFormatting( aBackPropSet, mrModel.mxShapeProp, OBJECTTYPE_CHARTSPACE );
 156
 157     bool bMSO2007Doc = getFilter().isMSO2007Document();
 158     // convert plot area (container of all chart type groups)
 159     PlotAreaConverter aPlotAreaConv( *this, mrModel.mxPlotArea.getOrCreate() );
 160     aPlotAreaConv.convertFromModel( mrModel.mxView3D.getOrCreate(bMSO2007Doc) );
 161
 162     // plot area converter has created the diagram object
 163     Reference< XDiagram > xDiagram = getChartDocument()->getFirstDiagram();
 164
 165     // convert wall and floor formatting in 3D charts
 166     if( xDiagram.is() && aPlotAreaConv.isWall3dChart() )
 167     {
 168         WallFloorConverter aFloorConv( *this, mrModel.mxFloor.getOrCreate() );
 169         aFloorConv.convertFromModel( xDiagram, OBJECTTYPE_FLOOR );
 170
 171         WallFloorConverter aWallConv( *this, mrModel.mxBackWall.getOrCreate() );
 172         aWallConv.convertFromModel( xDiagram, OBJECTTYPE_WALL );
 173     }
 174
 175     // chart title
 176     /* tdf#119138 autoTitleDeleted might be omitted by generators other than Excel
 177        while providing custom title. mbAutoTitleDel is set only based on the attribute value
 178        and the default also varies on whether MSO 2007 or newer is the generator, see tdf#78080 */
 179     if( !mrModel.mbAutoTitleDel || mrModel.mxTitle.is() ) try
 180     {
 181         /*  If the title model is missing, but the chart shows exactly one
 182             series, the series title is shown as chart title. */
 183         OUString aAutoTitle = aPlotAreaConv.getAutomaticTitle();
 184         if( mrModel.mxTitle.is() || !aAutoTitle.isEmpty() )
 185         {
 186             // tdf#146487 In some cases, we need to show the empty title
 187             bool bShowEmptyTitle = aAutoTitle.isEmpty() && !mrModel.mbAutoTitleDel
 188                                    && aPlotAreaConv.isSingleSeriesTitle()
 189                                    && mrModel.mxTitle->mxShapeProp.is()
 190                                    && mrModel.mxTitle->mxTextProp.is()
 191                                    && mrModel.mxTitle->mxTextProp->isEmpty();
 192             // Also for tdf#146487
 193             bool bEmptyRichText = mrModel.mxTitle
 194                 && mrModel.mxTitle->mxText.is()
 195                 && mrModel.mxTitle->mxText->mxTextBody.is()
 196                 && mrModel.mxTitle->mxText->mxTextBody->isEmpty();
 197
 198             if (aAutoTitle.isEmpty() && !bShowEmptyTitle && !bEmptyRichText)
 199                 aAutoTitle = OoxResId(STR_DIAGRAM_TITLE);
 200             Reference< XTitled > xTitled( getChartDocument(), UNO_QUERY_THROW );
 201             TitleConverter aTitleConv( *this, mrModel.mxTitle.getOrCreate() );
 202             aTitleConv.convertFromModel( xTitled, aAutoTitle, OBJECTTYPE_CHARTTITLE );
 203         }
 204     }
 205     catch( Exception& )
 206     {
 207     }
 208
 209     // legend
 210     if( xDiagram.is() && mrModel.mxLegend.is() )
 211     {
 212         LegendConverter aLegendConv( *this, *mrModel.mxLegend );
 213         aLegendConv.convertFromModel( xDiagram );
 214     }
 215
 216     // treatment of missing values
 217     if( xDiagram.is() )
 218     {
 219         using namespace ::com::sun::star::chart::MissingValueTreatment;
 220         sal_Int32 nMissingValues = LEAVE_GAP;
 221
 222         // tdf#134118 leave gap if the time unit is month
 223         bool bIsMonthBasedTimeUnit = false;
 224         if( mrModel.mxPlotArea.is() && mrModel.mxPlotArea->maAxes.size() > 0 &&
 225             mrModel.mxPlotArea->maAxes[0]->monBaseTimeUnit.has_value() )
 226         {
 227             bIsMonthBasedTimeUnit = mrModel.mxPlotArea->maAxes[0]->monBaseTimeUnit.value() == XML_months;
 228         }
 229
 230         if (!bIsMonthBasedTimeUnit) switch( mrModel.mnDispBlanksAs )
 231         {
 232             case XML_gap:   nMissingValues = LEAVE_GAP; break;
 233             case XML_zero:  nMissingValues = USE_ZERO;  break;
 234             case XML_span:  nMissingValues = CONTINUE;  break;
 235         }
 236
 237         // use a workaround, if it's possible for the difference of OOXML and OpenDocument
 238         if ( nMissingValues == LEAVE_GAP && lcl_useWorkaroundForNoGapInOOXML(getChartDocument()) )
 239             nMissingValues = USE_ZERO;
 240
 241         PropertySet aDiaProp( xDiagram );
 242         aDiaProp.setProperty( PROP_MissingValueTreatment, nMissingValues );
 243     }
 244
 245     /*  Following all conversions needing the old Chart1 API that involves full
 246         initialization of the chart view. */
 247     namespace cssc = css::chart;
 248     Reference< cssc::XChartDocument > xChart1Doc( getChartDocument(), UNO_QUERY );
 249     if( xChart1Doc.is() )
 250     {
 251         /*  Set the IncludeHiddenCells property via the old API as only this
 252             ensures that the data provider and all created sequences get this
 253             flag correctly. */
 254         PropertySet aDiaProp( xChart1Doc->getDiagram() );
 255         aDiaProp.setProperty( PROP_IncludeHiddenCells, !mrModel.mbPlotVisOnly );
 256
 257         // plot area position and size
 258         aPlotAreaConv.convertPositionFromModel();
 259
 260         // positions of main title and all axis titles
 261         convertTitlePositions();
 262     }
 263
 264     // embedded drawing shapes
 265     if( !mrModel.maDrawingPath.isEmpty() ) try
 266     {
 267         /*  Get the internal draw page of the chart document, if no external
 268             drawing page has been passed. */
 269         Reference< XShapes > xShapes;
 270         awt::Point aShapesOffset( 0, 0 );
 271         if( rxExternalPage.is() )
 272         {
 273             xShapes = rxExternalPage;
 274             // offset for embedded shapes to move them inside the chart area
 275             aShapesOffset = rChartPos;
 276         }
 277         else
 278         {
 279             Reference< XDrawPageSupplier > xDrawPageSupp( getChartDocument(), UNO_QUERY_THROW );
 280             xShapes.set( xDrawPageSupp->getDrawPage(), UNO_QUERY_THROW );
 281         }
 282
 283         /*  If an external drawing page is passed, all embedded shapes will be
 284             inserted there (used e.g. with 'chart sheets' in spreadsheet
 285             documents). In this case, all types of shapes including OLE objects
 286             are supported. If the shapes are inserted into the internal chart
 287             drawing page instead, it is not possible to embed OLE objects. */
 288         bool bOleSupport = rxExternalPage.is();
 289
 290         awt::Size aChartSize = getChartSize();
 291         if( aChartSize.Width <= 0 || aChartSize.Height <= 0 )
 292             aChartSize = getDefaultPageSize();
 293
 294         // now, xShapes is not null anymore
 295         getFilter().importFragment( new ChartDrawingFragment(
 296             getFilter(), mrModel.maDrawingPath, xShapes, aChartSize, aShapesOffset, bOleSupport ) );
 297     }
 298     catch( Exception& )
 299     {
 300     }
 301
 302     // pivot chart
 303     if ( mrModel.mbPivotChart )
 304     {
 305         PropertySet aProps( getChartDocument() );
 306         aProps.setProperty( PROP_DisableDataTableDialog , true );
 307         aProps.setProperty( PROP_DisableComplexChartTypes , true );
 308     }
 309
 310     if(!mrModel.maSheetPath.isEmpty() )
 311     {
 312         Reference< css::chart::XChartDocument > xChartDoc( getChartDocument(), UNO_QUERY );
 313         PropertySet aProps( xChartDoc->getDiagram() );
 314         aProps.setProperty( PROP_ExternalData , uno::Any(mrModel.maSheetPath) );
 315     }
 316 }
 317
 318 } // namespace oox::drawingml::chart
 319
 320 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */