Plot.h

Go to the documentation of this file.

//====================================================================
//  Filename:       Plot.h
//  Date:           2008-05-21
//  Authors:        Bing Huang

//  Copyright (C) 1997-2008 MicroStrategy Incorporated
//  All rights reserved
//====================================================================

#ifndef MsiChart_Plot_h
#define MsiChart_Plot_h

#include "../Dataset.h"
#include "Legend.h"

#include "GraphObjectManager.h"
#include "TrendLineObject.h"
#include "DataLabelManager.h"

namespace MsiChart
{
    //enumerations and structs
    typedef enum
    {
        TLI_Y1 = 0,
        TLI_Y2 = 1,
        TLI_BOTH = 2
    }EnumTrendLineIndex;
    
    struct GraphTrendLineOptions
    {
        GraphTrendLineOptions() : mRegressionType(DssGraphRegressionNone)
        , mOrder(3), mPeriod(2), mShowEquation(false), mShowCoefficients(false)
        , mUserSeriesGraphColor(true), mUseSeasonal(false), mIsExpomentialBaseNearOne(false)
        {}
        
        void GetOptions(Int32 iPropertyId, VARIANT* opValue) const;
        
        EnumDSSGraphRegressionType      mRegressionType;
        Int32                           mOrder;
        Int32                           mPeriod;
        bool                            mShowEquation;
        bool                            mShowCoefficients;
        bool                            mUserSeriesGraphColor;
        bool                            mUseSeasonal;
        bool                            mIsExpomentialBaseNearOne;
    };
    
    typedef enum
    {
        VA_Y1 = 0,
        VA_Y2 = 1,
        VA_BOTH = 2,
        VA_Y3,
        VA_Y4
    }EnumValueAxis;

    //pre-declaration
    class TextObject;
    class TrendLineObject;

    /*
        virtual base class for all plot classes
    */
    class Plot : public GraphObjectManager
    {
    public:
        typedef MSynch::SmartPtr<Plot> Ptr;
        
        //ctor & dtor
        Plot(const TripleId& irTripleId, GraphObjectManager* ipManager, const Rect2D& irDataArea);
        virtual ~Plot();

        //Pure virtual functions from GraphObjectManager
        virtual void Draw();
        virtual void GenerateView();
        virtual void GenerateImageMap(ImageMap &iorImageMap);
        
        //Virtual functions from GraphObjectManager
        virtual GraphObject::Ptr OnPointDetection(const Point2D& irCursor) const; 
        virtual void OnRectangleSelection(const Rect2D& irRect, std::vector<GraphObject::Ptr>& iorSelectedObjects) const;

        virtual bool GetToolTipData(Int32 iSeriesID, Int32 iGroupID, double& orValue, double& orPercentValue, Int32 iOffset = 0);
        
        virtual bool GetGroupSpace(std::vector<Int32>& orVect, Int32 iGroupIndex); //< voice over
        virtual Int32 GetMaxElementRadius();    //< graph matrix
        virtual void RefreshValueAxis(const std::map<Int32, std::pair<double, double> >& irScaleSet, const Rect2D& irRect);
        virtual bool GetMaxElementOffsetClippedByBoundary(bool iIsOnXAxis, double& orLowOffset, double& orHighOffset);
        virtual bool GetGMPiePositon(Point2D& orCood, double iXInput, double iYInput, Int32 iXSubIndex = 0, Int32 iYSubIndex = 0, Int32 iXSectionCount = 1, Int32 iYSectionCount = 1,Int32 iRadius = 2);

        virtual void DrawTrendLinesAndEquations();
        void GetDataArea(Rect2D& orDataArea) const;

        void SetDataArea(const Rect2D& irDataArea);

        Dataset::Ptr GetDataset() const;

        Legend::Ptr GetLegend() const;

        void SetDataset(Dataset::Ptr iDataSetPtr);

        void SetLegend(Legend::Ptr iLegendPtr);

        void AddSeries(Int32 iSeriesId);


        Int32 GetSeriesIndexByID(Int32 iSeriesId) const;

        void MoveLabel(TextObject* ipTextObject, const Point2D& irTopRight, const Point2D& irBottomLeft, bool iIsReverse, bool iIsVertical, EnumDSSGraphDataTextPosition iLabelLocation) const;
        /*void MoveLabel(TextObject* ipTextObject, const Point2D& irTopRight, const Point2D& irBottomLeft, bool iIsReverse, bool iIsVertical, EnumDSSGraphDataTextPosition iLabelLocation, bool iSmart) const;
        bool IsLabelClipped(TextObject* ipTextObject, bool iIsVertical, EnumDSSGraphDataTextPosition iOriginalPosition, EnumDSSGraphDataTextPosition& iorBestPosition) const;*/

        void AddLegendMarkerToCollection(Int32 iSeriesId, GraphCollectionObject* ipRiserCollection, bool iIsLineCollection = false, bool iIsShownMarker = true, unsigned char iMarkerShape = DssGraphMarkerShapeRectangle, bool iIsShownLine = true, bool iIsLineVertical = false) const;

        void CreateTrendLine(const std::vector<double>& irX, const std::vector<double>& irY, const TripleId& irTripleId, 
                             GraphObjectManager* ipManager, GraphCollectionObject* ipParentObject, Axis* ipXAxis, Axis* ipYAxis,
                             GraphTrendLineOptions* ipTrendLineOptions, const Rect2D& irDataArea, bool iIsVertical, const Point2D& irDepthOffset, bool iIsY2 = false);
        
        void AdjustTrendLineEquation(Rect2D& irRect, EnumTrendLineIndex iIndex);
        
        void DrawTrendLinesAndEquations(Rect2D& irClipRect, bool iIsY2 = false);
        
        void DrawPostTrendLineObjects();
        
        void GeneratePostTrendLineViews();
        
        bool HasTrendLines() const;
        
        void AddTrendLineAnadRefLine(GraphObject::Ptr iLine);
        
        DataLabelManager::Ptr GetDataLabelManager();
        
        //kai;2016/Jul/26;DE35637;fix GM referenceline issue, change to metric to decide whether to draw
        bool GetVAMetricIndexDrawn(Int32 iValueMetricIndex);
        void SetVAMetricIndexDrawn(Int32 iValueMetricIndex);
        /*
        bool GetVAIndexDrawn(Int32 iValueAxis);
        void SetVAIndexDrawn(Int32 iValueAxis, bool iDrawn);
         */
    protected:
        void LoadTrendLineProperties(Int32 iSeriesId, GraphTrendLineOptions& iorTrendLineOption) const;
            
        void LoadValueAxisInfo(Int32 iSeriesIndex, bool iIsDualAxes, EnumValueAxis& orValueAxis) const;

        Dataset::Ptr mDatasetPtr;
        Legend::Ptr mLegendPtr;

        std::vector<Int32> mGroupID;
        std::vector<Int32> mSeriesId;
        Rect2D mDataArea;

        //use to put trend line object.
        std::vector<TrendLineObject::Ptr> mTrendLines[2];
        
        //use to put the objects that should be draw after trend line.
        //for example, custom line and series text labels.
        std::vector<GraphObject::Ptr> mPostTrendLineObjects;    
        
        // GM Text objects manager including data label and reference line label.
        DataLabelManager::Ptr mLabelManager;
        
        // RefLineSupport
        bool mVAIndexDrawn[5];
        std::set<Int32> mVAIndexDrawnSet;

    private:
        void hUpdateTrendLineFormatLine(TrendLineObject::Ptr iTrendLinePtr);
    };

    inline Dataset::Ptr Plot::GetDataset() const
    {
        return mDatasetPtr;
    }

    inline Legend::Ptr Plot::GetLegend() const
    {
        return mLegendPtr;
    }

    inline void Plot::SetLegend(Legend::Ptr iLegendPtr)
    {
        mLegendPtr = iLegendPtr;
    }
    
    inline void Plot::SetDataset(Dataset::Ptr iDataSetPtr)
    {
        mDatasetPtr = iDataSetPtr;
    }

    inline void Plot::AddSeries(Int32 iSeriesId)
    {
        mSeriesId.push_back(iSeriesId);
    }   
    
    inline bool Plot::HasTrendLines() const
    {
        return !mTrendLines[0].empty() || !mTrendLines[1].empty();
    }
    
    inline DataLabelManager::Ptr Plot::GetDataLabelManager()
    {
        if (mLabelManager.IsNull()) {
            mLabelManager = new DataLabelManager(mChartContextPtr, mpManager);
        }
        return mLabelManager;
    }
    /*
    inline bool Plot::GetVAIndexDrawn(Int32 iValueAxisIndex)
    {
        return mVAIndexDrawn[iValueAxisIndex];
    }
    
    inline void Plot::SetVAIndexDrawn(Int32 iValueAxisIndex, bool iDrawn)
    {
        mVAIndexDrawn[iValueAxisIndex] = iDrawn;
    }
     */
    
    inline bool Plot::GetVAMetricIndexDrawn(Int32 iValueMetricIndex)
    {
        return mVAIndexDrawnSet.find(iValueMetricIndex) != mVAIndexDrawnSet.end();
    }
    
    inline void Plot::SetVAMetricIndexDrawn(Int32 iValueMetricIndex)
    {
        mVAIndexDrawnSet.insert(iValueMetricIndex);
    }
    
}

#endif