| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef CHART2_DATASERIESHELPER_HXX |
| #define CHART2_DATASERIESHELPER_HXX |
| |
| #include <com/sun/star/chart2/data/XDataSequence.hpp> |
| #include <com/sun/star/chart2/data/XDataSource.hpp> |
| #include <com/sun/star/chart2/XDataSeries.hpp> |
| #include <com/sun/star/chart2/XDiagram.hpp> |
| #include <com/sun/star/chart2/XCoordinateSystem.hpp> |
| #include <com/sun/star/chart2/XChartType.hpp> |
| |
| #include "StackMode.hxx" |
| #include "charttoolsdllapi.hxx" |
| |
| #include <vector> |
| #include <functional> |
| #include <hash_set> |
| |
| namespace chart |
| { |
| |
| namespace DataSeriesHelper |
| { |
| |
| ::rtl::OUString GetRole( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::data::XLabeledDataSequence >& xLabeledDataSequence ); |
| |
| /** Retrieves the data sequence in the given data source that matches the |
| given role. If more than one sequences match the role, the first match |
| is returned. If no sequence matches, an empty reference is returned. |
| |
| @param aSource |
| The data source containing all data sequences to be searched through. |
| |
| @param aRole |
| The role that is to be filtered out. |
| */ |
| OOO_DLLPUBLIC_CHARTTOOLS ::com::sun::star::uno::Reference< ::com::sun::star::chart2::data::XLabeledDataSequence > |
| getDataSequenceByRole( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::data::XDataSource > & xSource, |
| ::rtl::OUString aRole, |
| bool bMatchPrefix = false ); |
| |
| /** Retrieves all data sequences in the given data source that match the given |
| role. |
| |
| @param aSource |
| The data source containing all data sequences to be searched through. |
| |
| @param aRole |
| The role that is to be filtered out. |
| */ |
| OOO_DLLPUBLIC_CHARTTOOLS ::std::vector< |
| ::com::sun::star::uno::Reference< ::com::sun::star::chart2::data::XLabeledDataSequence > > |
| getAllDataSequencesByRole( const ::com::sun::star::uno::Sequence< |
| ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::data::XLabeledDataSequence > > & aDataSequences, |
| ::rtl::OUString aRole, |
| bool bMatchPrefix = false ); |
| |
| /** Retrieves all data sequences found in the given data series and puts them |
| into a data source. The order of sequences will match the order of the data |
| series. |
| */ |
| OOO_DLLPUBLIC_CHARTTOOLS ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::data::XDataSource > |
| getDataSource( const ::com::sun::star::uno::Sequence< |
| ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries > > & aSeries ); |
| |
| |
| /** Get the label of a series (e.g. for the legend) |
| |
| @param rLabelSequenceRole |
| The data sequence contained in xSeries that has this role will be used |
| to take its label. |
| */ |
| OOO_DLLPUBLIC_CHARTTOOLS ::rtl::OUString getDataSeriesLabel( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries > & xSeries, |
| const ::rtl::OUString & rLabelSequenceRole ); |
| |
| /** Get the label of a labeled sequence including neccessary automatic generation |
| */ |
| OOO_DLLPUBLIC_CHARTTOOLS ::rtl::OUString getLabelForLabeledDataSequence( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::data::XLabeledDataSequence > & xLabeledSeq ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void setStackModeAtSeries( |
| const ::com::sun::star::uno::Sequence< |
| ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > > & aSeries, |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XCoordinateSystem > & xCorrespondingCoordinateSystem, |
| StackMode eStackMode ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS sal_Int32 getAttachedAxisIndex( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > & xSeries ); |
| |
| /// @param nAxisIndex, if -1 it is determined by the given data series via getAttachedAxisIndex |
| OOO_DLLPUBLIC_CHARTTOOLS sal_Int32 getNumberFormatKeyFromAxis( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > & xSeries, |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XCoordinateSystem > & xCorrespondingCoordinateSystem, |
| sal_Int32 nDimensionIndex, |
| sal_Int32 nAxisIndex = -1 ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS |
| ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XCoordinateSystem > |
| getCoordinateSystemOfSeries( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > & xSeries, |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDiagram > & xDiagram ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS |
| ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartType > |
| getChartTypeOfSeries( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > & xSeries, |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDiagram > & xDiagram ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void deleteSeries( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries > & xSeries, |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XChartType > & xChartType ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void switchSymbolsOnOrOff( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::beans::XPropertySet > & xSeriesProperties, |
| bool bSymbolsOn, sal_Int32 nSeriesIndex ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void switchLinesOnOrOff( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::beans::XPropertySet > & xSeriesProperties, |
| bool bLinesOn ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS |
| void makeLinesThickOrThin( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::beans::XPropertySet > & xSeriesProperties, bool bThick ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void setPropertyAlsoToAllAttributedDataPoints( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries, |
| const ::rtl::OUString& rPropertyName, |
| const ::com::sun::star::uno::Any& rPropertyValue ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS bool hasAttributedDataPointDifferentValue( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries, |
| const ::rtl::OUString& rPropertyName, |
| const ::com::sun::star::uno::Any& rPropertyValue ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS bool areAllSeriesAttachedToSameAxis( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartType >& xChartType, |
| sal_Int32 & rOutAxisIndex ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS bool hasUnhiddenData( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS |
| sal_Int32 translateIndexFromHiddenToFullSequence( sal_Int32 nClippedIndex, const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::data::XDataSequence >& xDataSequence, bool bTranslate ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS bool hasDataLabelsAtSeries( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS bool hasDataLabelsAtPoints( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS bool hasDataLabelAtPoint( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries, sal_Int32 nPointIndex ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void insertDataLabelsToSeriesAndAllPoints( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void insertDataLabelToPoint( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::beans::XPropertySet >& xPointPropertySet ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void deleteDataLabelsFromSeriesAndAllPoints( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::chart2::XDataSeries >& xSeries ); |
| |
| OOO_DLLPUBLIC_CHARTTOOLS void deleteDataLabelsFromPoint( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::beans::XPropertySet >& xPointPropertySet ); |
| |
| } // namespace DataSeriesHelper |
| } // namespace chart |
| |
| // CHART2_DATASERIESHELPER_HXX |
| #endif |