HistogramPlot.h

Go to the documentation of this file.

//====================================================================
//  Filename:       Kernel/SourceCode/ChartEngine/PrivateSource/HistogramPlot.h
//  AUTHOR      :   Xin Liu
//  CREATION    :   2/13/09
//  Copyright (C) MicroStrategy, Inc. 2009
//==============================================================================================

#ifndef MSICHART_HISTOGRAMPLOT_H
#define MSICHART_HISTOGRAMPLOT_H

#include "Plot.h"
#include "ValueAxis.h"
#include "CategoryPlot.h"
#include "NumberObject.h"

namespace MsiChart
{
    struct HistogramOptions
    {
        HistogramOptions()
            : mGraphType(DssGraphTypeVertical_Histogram) 
            , mOrientation(OR_VERTICAL)
            , mUseDepth(false)
            , mDepth(200)
            , mDepthDirection(45)
            , mShowDataLabel(false)
            , mGapWidth(40)
            , mTextPosition(DssGraphDTPositionOutMax)
        {}
        EnumDSSGraphType        mGraphType;
        EnumOrientation         mOrientation;
        Int32                   mGapWidth;  
        bool                    mUseDepth;
        Int32                   mDepth;
        Int32                   mDepthDirection;
        bool                    mShowDataLabel;
    //  bool                    mShowValue;     
        EnumDSSGraphDataTextPosition        mTextPosition;
    //  EnumDSSGraphDataTextShowType        mTextShowType;
        ChartAdvFormat                      mGraphNumberFormat;
        GraphTrendLineOptions               mTrendLineOptions;
    };

    /*
    struct HistogramSeriesOptions
    {
        typedef MSynch::SmartPtr<HistogramSeriesOptions> Ptr;

        SeriesOptions() : mShowDataLabels(false)
        {}

        bool                        mShowDataLabels;    
        GraphTrendLineOptions       mTrendLineOptions;
        ChartAdvFormat              mGraphNumberFormat;
    };
    

    struct HistogramPlotContext
    {
        HistogramOptions mHistogramOptions;

        ValueAxis::Ptr mXValueAxis;
        ValueAxis::Ptr mY1ValueAxis;
    };
    */
    class HistogramPlot: public Plot
    {
    public:
        typedef MSynch::SmartPtr<HistogramPlot> Ptr;

        HistogramPlot(const TripleId& irTripleId, GraphObjectManager* ipManager, const Rect2D& irDataArea);
        ~HistogramPlot();

        //Re-implemention the virtual functions inherited from GraphObjectManager
        virtual GraphObject::Ptr OnPointDetection(const Point2D& irCursor) const; 
        virtual void OnRectangleSelection(const Rect2D& irRect, std::vector<GraphObject::Ptr>& iorSelectedObjects) const;
        virtual void Draw();
        virtual void GenerateView();
        virtual void GenerateImageMap(ImageMap& iorImageMap); 
        virtual void GenerateMapAndList(); 
        virtual void GetOptions(Int32 iSeriesId, Int32 iPropertyId, CComVariant* opValue) const;

        virtual bool GetToolTipData(Int32 iSeriesID, Int32 iGroupID, double& orValue, double& orPercentValue);
        virtual bool GetToolTipData(Int32 iSeriesID, Int32 iGroupID, double& orValue, double& orPercentValue, Int32 iOffset);

        void GetXMinMaxValue(double& iorMin, double& iorMax, bool& iorIsInitialized);

        void GetY1MinMaxValue(double& iorMin, double& iorMax, bool& iorIsInitialized);

        void SetXValueAxis(ValueAxis::Ptr iValueAxisPtr);

        void SetY1ValueAxis(ValueAxis::Ptr iValueAxisPtr);

        bool IsReverseGroupOrder();

    protected:
        virtual void SetGraphType(EnumDSSGraphType iType);

    private:
        void hCalculateHistogramData();

        void hLoadProperties();

        void hLoadTrendlineProperties();

        void hGenerateOneRiser(Int32 iGroupId);

        void hGetRiserStartPosAndSize(Int32 iGroupId, Int32& orStart, Int32& orSize);

        TextObject::Ptr hCreateDataLabel(Int32 iGroupId, const double& irValue, GraphCollectionObject::Ptr iDataLabelCollectionPtr);

        void hGenerateTrendline();

        //private members
        std::vector<double> mHistogramData;     
        std::vector<double> mHistogramDataX;    
        ValueAxis::Ptr mXValueAxisPtr;          
        ValueAxis::Ptr mY1ValueAxisPtr;         
        HistogramOptions mHistogramOptions;     

        GraphCollectionObject::Ptr mRiserCollectionPtr;     
        GraphCollectionObject::Ptr mDataLabelCollectionPtr; 
    };
}

#endif