BoxPlot.h

Go to the documentation of this file.

//=======================================================================
//  Filename:       Kernel/SourceCode/ChartEngine/PrivateSource/BoxPlot.h
//  Date:           2009-03-02
//  Authors:        Bing Huang

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

#ifndef MsiChart_BoxPlot_h
#define MsiChart_BoxPlot_h

#include "CategoryPlot.h"
#include "CategoryAxis.h"
#include "ValueAxis.h"

namespace MsiChart
{
    //enumerations and structs
    struct BoxSeriesOptions
    {
        typedef MSynch::SmartPtr<BoxSeriesOptions> Ptr;

        BoxSeriesOptions() : mShowDataLabels(false), mMarkerShape(0), mMarkerSize(50)
        {}

        bool            mShowDataLabels;
        unsigned char   mMarkerShape;
        Int32           mMarkerSize;
        ChartAdvFormat              mGraphNumberFormat;
        
    };

    class BoxPlot : public CategoryPlot
    {
    public:
        typedef MSynch::SmartPtr<BoxPlot> Ptr;

        BoxPlot(const TripleId& irTripleId, GraphObjectManager* ipManager, const Rect2D& irDeviceRect);
        
        //virtual functions from GraphObjectManager
        virtual void GenerateMapAndList();
        virtual void GetOptions(Int32 iSeriesId, Int32 iPropertyId, CComVariant* opValue) const;
        
        //pure virtual functions from CategoryPlot
        virtual void Init();
        virtual void GetMinMaxValue(EnumValueAxis iValueAxis, double& iorMin, double& iorMax, bool& iorAreInitialized);
        virtual void AddValueAxis(ValueAxis::Ptr iValueAxisPtr);
        virtual void SetCategoryAxis(CategoryAxis::Ptr iCategoryAxisPtr);
                
    protected:

    private:
        void hLoadProperties();

        void hLoadSeriesProperties(Int32 iSeriesIndex);

        void hCalBarMarkerWidthAndSpaces();

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

        //bool hGetRiserRect(Int32 iSeriesIndex, Int32 iGroupId, Rect2D& orRect);

        void hCreateFiveNumberLabels(Int32 iGroupId, double iFiveNumbers[], bool iIsNull[], std::vector<GraphCollectionObject::Ptr>& irTextCollection);

        void hCreateBoxPlotBodyForGroup(Int32 iGroupId, std::vector<GraphCollectionObject::Ptr>& irRiserCollection, std::vector<GraphCollectionObject::Ptr>& irLineCollection, std::vector<GraphCollectionObject::Ptr>& irTextCollection);

        void hCreateMarkersAndLabels(std::vector<GraphCollectionObject::Ptr>& irRiserCollection, std::vector<GraphCollectionObject::Ptr>& irTextCollection);

        void hCreatelabels(Int32 iSeriesIndex, Int32 iGroupId, const double& irValue, const Point2D& irTopRight, const Point2D& irBottomLeft, bool iIsReverse, GraphCollectionObject::Ptr iCollectionPtr);

        void hGetFiveNumber(Int32 iGroupId, double ioFiveNumbers[], bool ioIsNull[]);

        void hCreateOneRectangle(Int32 iStartX, Int32 iSizeX, const double& irStartYValue, const double& irEndYValue, Int32 iSeriesId, Int32 iGroupId, GraphCollectionObject::Ptr iCollectionPtr);

        void hCreateLine(const TripleId& irTripleId, const Point2D& irStart, const Point2D& irEnd, GraphCollectionObject::Ptr iCollectionPtr);

        CategoryAxis::Ptr mCategoryAxisPtr;
        ValueAxis::Ptr mValueAxisPtr;
        EnumDSSBoxPlotTailShape mTailShape;
        double mBarWidth;
        double mMarkerWidth;
        double mSpaceBetweenMarker;
        double mSpaceBetweenGroupBar;
        double mSpaceBetweenGroupMarker;
        Int32 mSeriesCount;
        Int32 mGroupCount;
        Int32 mOverlap;
        Int32 mGapWidth;
        bool mShowLabel;
        bool mShowValue;
        EnumDSSGraphDataTextPosition            mTextPosition;
        ChartAdvFormat                          mTotalNumberFormat;
        std::vector<BoxSeriesOptions::Ptr>  mBoxSeriesOptions;
    };

}

#endif