#include <Chart.h>

Inheritance diagram for MsiChart::Chart:

Public Member Functions
virtual void	Delete ()=0

virtual void	SetData (Dataset::Ptr iDatasetPtr)=0

virtual Dataset::Ptr	GetData ()=0

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

virtual bool	GetToolTipDataString (Int32 iSeriesID, Int32 iGroupID, MBase::String &orDataString, Int32 iOffset=0)=0

virtual bool	GetToolTipDataString (Int32 iSeriesID, Int32 iGroupID, MBase::String &orDataString, MBase::String &orPercentDataString, Int32 iOffset=0)=0

virtual bool	GetPieSliceTooltipDataString (Int32 iSeriesID, Int32 iGroupID, Int32 iAngleID, Int32 iSliceID, Int32 iColumnOffset, MBase::String &orDataString)=0

virtual bool	GetPrimaryDataString (Int32 iSeriesID, Int32 iGroupID, MBase::String &orDataString, bool iIsForColor, Int32 iSizebyIndex=0)=0

virtual bool	GetPrimaryDataStringForPie (Int32 iSeriesId, Int32 iGroupID, MBase::String &orDataString, bool iIsForColor, Int32 iColumnOffset=0, bool isPercentValue=false, Int32 iAngleIndex=-3, Int32 iSlcieIndex=-3)=0

virtual bool	IsInitialized () const =0

virtual bool	SetOptions (Int32 iObjectId, Int32 iSeriesId, Int32 iGroupId, Int32 iPropertyId, CComVariant *ipValue)=0

virtual bool	GetOptions (Int32 iObjectId, Int32 iSeriesId, Int32 iGroupId, Int32 iPropertyId, CComVariant *opValue)=0

virtual void	SetGraphType (short iGraphType)=0

virtual void	GetGraphType (short &orGraphType)=0

virtual void	SetAdvancedChartTypeSupport (bool iAdvancedChartTypeSupport)=0

virtual Int32	GetGraphWidth () const =0

virtual Int32	GetGraphHeight () const =0

virtual void	SetCurrentGraphFrame (Int32 iX, Int32 iY, Int32 iWidth, Int32 iHeight)=0

virtual void	SetChartComponent (Int32 iChartComponent)=0

virtual Int32	GetDataAreaSplitX () const =0

virtual Int32	GetDataAreaSplitY () const =0

virtual void	SetDataAreaSplitX (Int32 iXCoord)=0

virtual bool	OnPointDetection (Int32 iX, Int32 iY, bool iSmartSelection, TripleId &orSelectedObject)=0

virtual bool	GetNearestObject (Int32 iX, Int32 iY, const std::vector< Int32 > &irObjectIds, Int32 iRadius, TripleId &orNearestTripleId, int *opNearestDistance=NULL)=0

virtual bool	GetNearestObjectForGMCombo (Int32 iX, Int32 iY, const std::vector< Int32 > &irObjectIds, Int32 iRadius, TripleId &orNearestTripleId, int *opNearestDistance)=0

virtual bool	GetAllObjectsWithInDistance (Int32 iX, Int32 iY, const std::vector< Int32 > &irObjectIds, Int32 iRadius, std::vector< SelectedInfo > &orNearObjects, std::vector< Int32 > &orDistance)=0

virtual bool	OnRectangleSelection (Int32 iLeft, Int32 iTop, Int32 iWidth, Int32 iHeight, bool iSmartSelection, TripleId *&orpSelectionList, Int32 &oNum)=0

virtual bool	IsInSelectionList (const TripleId &iObject)=0

virtual bool	AddToSelectionList (const TripleId &iObject)=0

virtual bool	RemoveFromSelectionList (const TripleId &iObject)=0

virtual void	ClearSelectionList ()=0

virtual void	AllocSelectionList (TripleId *&orpSelectionList, Int32 &oNum)=0

virtual void	DisposeSelectionList (TripleId *ipSelectionList)=0

virtual bool	SaveImageToMemory (Int32 iWidth, Int32 iHeight, Int32 iFormat, char *&oprMemory, unsigned Int32 &oSize)=0

virtual bool	SaveImageToFile (Int32 iWidth, Int32 iHeight, Int32 iFormat, const char *ipFilename)=0

virtual bool	SaveImageToCGContext (CGContext *ipCGContext, Int32 iWidth, Int32 iHeight, bool iShowValueAxis=true, Int32 iImageUsage=IU_GENERAL)=0

virtual bool	GenerateImageMap (Int32 iWidth, Int32 iHeight, ImageMap &oImageMap)=0

virtual bool	PlainDraw (Int32 iWidth, Int32 iHeight)=0

virtual void	SetCGContext (CGContext *ipCGContext)=0

virtual void	SetIsCategoryXAxisForPartialRendering (bool isForPartialRendering)=0

virtual Int32	GetChartAreaId (const TripleId &iObject)=0

virtual void	DeviceToVirtualPoint (Int32 &iorX, Int32 &iorY) const =0

virtual void	VirtualToDevicePoint (Int32 &iorX, Int32 &iorY) const =0

virtual Int32	GetDataGroup (bool &orIgnoreForNoSeriesOrGroup) const =0

virtual void	GetAxisNumberFormat (CComVariant *opValue) const =0

virtual void	OnZooming (Int32 iOldStart, Int32 iOldEnd, Int32 iNewStart, Int32 iNewEnd, bool iIsVertical)=0

virtual void	OnZoomingByGroupRange (double iStartGroup, double iEndGroup)=0

virtual void	OnZoomRestore ()=0

virtual void	OnSwipingOutOfZoom (Int32 iOffset)=0

virtual void	OnSwipingInZoom (Int32 iX, Int32 iY)=0

virtual Int32	GetLastGroupId ()=0

virtual bool	GetPositionById (Int32 iSeriesId, Int32 iGroupId, Int32 &orX, Int32 &orY)=0

virtual void	ResetGroupRangeAndAxesState (Int32 iBeginGroup, Int32 iEndGroup)=0

virtual double	GetGroupIntervalInPixel ()=0

virtual void	GetGroupLabel (Int32 iGroupId, MBase::String &orGroupLabel, const wchar_t iSeparator, bool iIsAbbreviated)=0

virtual void	GetSeriesLabel (Int32 iSeriesID, MBase::String &orSeriesLabel, bool iSubstitute=true, Int32 iColumnOffset=0, bool iIsForSlice=true)=0

virtual Tooltip *	CreateToolTipBySeriesAndGroup (Int32 iSeriesID, Int32 iGroupID, bool iPersistent=false)=0

virtual unsigned Int32	GetToolTipByCoords (Int32 iX, Int32 iY, std::vector< Tooltip *> &orTooltips, bool iPersistent=false)=0

virtual unsigned Int32	GetToolTipByCoords (Int32 iX, Int32 iY, std::vector< Tooltip *> &orTooltips, Int32 iDetectiveRadius, bool iPersistent=false)=0

virtual Int32	CreateTooltipByObject (TripleId ipSelectionList, Int32 iNum, std::vector< Tooltip > &orTooltips, bool iPersistent=false)=0

virtual Int32	CreateTooltipByObject (const std::vector< TripleId > &irSelectionList, std::vector< Tooltip *> &orTooltips, bool iPersistent=false)=0

virtual bool	CanShowTooltipById (TripleId &irId) const =0

virtual int	GetDataPointForUIMenu (Int32 iX, Int32 iY, Tooltip &ioTooltip, bool iLSMode=false)=0

virtual int	GetNumOfSelectedObjects ()=0

virtual int	ApplySelectedObjects (Int32 iX, Int32 iY, std::vector< Point2D > &iPoints, Point2D &ioPoint)=0

virtual bool	OnHover (Int32 iX, Int32 iY)=0

virtual bool	OnHover (Int32 iX, Int32 iY, Int32 iDistance)=0

virtual void	SetChartOffset (Int32 iXOffset, Int32 iYOffset)=0

virtual void	HighlightOrHideOneObject (const TripleId irTripleId, bool iIsHide)=0

virtual void	HighlightOrHideObjects (const std::vector< TripleId > &irTripleIds, bool iIsHide)=0

virtual bool	OnHover (const TripleId &irHoverObject)=0

virtual bool	ClearOneHighlightObject (MsiChart::TripleId iTripleId)=0

virtual bool	GetHoveredObject (TripleId &orHoveredObject, Int32 iIndex=0)=0

virtual bool	GetHoveredLineObject (TripleId &orHoveredLineObject, Int32 iIndex=0)=0

virtual void	GetAllGraphObjectInfo (std::vector< CGRect > &iAllGraphObjectsBorder, std::vector< MsiChart::TripleId > &iAllGraphObjectsTripleId)=0

virtual void	SetGMZoomScale (float iHeightScale, float iWidthScale)=0

virtual void	GetShownNumericTicks (std::set< double > &orTicksSet, bool iIsForXAxis)=0

virtual void	SetShowNumbericTicks (std::set< double > &irTicksSet, bool iIsForXAxis)=0

virtual void	GetStaggerLabelEndLevel (Int32 &orLabelEndLevel)=0

virtual void	SetStaggerLabelStartLevel (Int32 irLabelStartLevel)=0

virtual void	SetCategoryAxisLabelInterval (Int32 irLabelInterval)=0

virtual Int32	GetCategoryAxisLabelInterval ()=0

virtual void	SetXAxisLogicalRange (double iXLogicalStart, double iXLogicalEnd)=0

virtual void	EnableVoiceOver (bool iIsVoiceOverMode)=0

virtual void	EnableTimeSeriesChart (bool iIsTimeSeriesChart)=0

virtual void	EnableMicroChart (bool iIsMicroChart)=0

virtual void	SetTimeSeriesIntegrity (Int32 iIntegrity)=0

virtual void	EnableGraphMatrix (bool iIsGraphMatrix)=0

virtual void	EnableVIDocument (bool iIsVIDocument)=0

virtual void	SetTemplateNodeKey (const std::string &irKey)=0

virtual void	SetGridGraphViewer (void *ipGridGraphViewer)=0

virtual void	EnableAnimation (bool iUseAnimation)=0

virtual void	ResetAnimationState ()=0

virtual void	SetAnimationDuration (double iSeconds)=0

virtual void	HideAxisElements (bool iHide)=0

virtual void	EnableUniformAxis (GraphMatrixMinMaxInfo yMinMaxInfo, GraphMatrixMinMaxInfo xMinMaxInfo, GraphMatrixMinMaxInfo zMinMaxInfo, Int32 iGraphHeight, GraphMatrixMinMaxInfo y2MinMaxInfo=std::make_pair(-1, std::make_pair(0.0, 0.0)), GraphMatrixMinMaxInfo x2MinMaxInfo=std::make_pair(-1, std::make_pair(0.0, 0.0)))=0

virtual Int32	GetUniformYAxisWidth (Int32 iYAxisLength, Int32 iMetricIndex=-1, bool iIsForSecondaryAxis=false)=0

virtual Int32	GetUniformXAxisHeight (Int32 iXAxisLength, Int32 iMetricIndex=-1, bool iIsForSecondaryAxis=false)=0

virtual void	DrawUniformYAxis (CGContext *ipCGContext, Int32 iWidth, Int32 iHeight, bool iIsForSecondaryAxis=false)=0

virtual void	DrawUniformXAxis (CGContext *ipCGContext, Int32 iWidth, Int32 iHeight, bool iIsForSecondaryAxis=false)=0

virtual void	DrawDataAreaForUniformAxis (CGContext *ipCGContext, Int32 iWidth, Int32 iHeight)=0

virtual void	GetUniformAxisMargins (short &orLeftMargin, short &orRightMargin, short &orTopMargin, short &orBottomMargin, bool iIsForSecondaryAxis=false)=0

virtual void	SetUniformAxisMargins (short iLeftMargin, short iRightMargin, short iTopMargin, short iBottomMargin, bool iIsForSecondaryAxis=false)=0

virtual bool	GetRowAndColumnIndexByCoords (int iX, int iY, int &orRowIndex, int &orColumnIndex, bool iIsDataCellOnly, int iDistance=-1)=0

virtual bool	IsDrillableLabelAtCoords (int iX, int iY, std::string &orLinkURL)=0

virtual void	SetFormatManager (FormatManager::Ptr iFormatManagerPtr)=0
	Set a new FormatManager to current chart. More...

virtual void	GetHighlightObjects (std::vector< std::pair< Int32, Int32 > > &orHighlightObjects) const =0

virtual void	GetHighlightObjects (std::vector< MsiChart::TripleId > &orHighlightObjects) const =0

virtual void	HighlightSelectedObject (bool iHighlight, bool iIsForLassoSelction=false)=0
	Highlight selected object. More...

virtual void	GetSOByLassoSelection (std::vector< std::pair< int, int > > &iObjects)=0
	Get Selected Objects by Lasso Selections. More...

virtual void	HighlightSelectedInInit (std::vector< std::pair< Int32, Int32 > > &iSelectedSeriesAndColumns)=0
	Highlight selected object when the graph document is opened. More...

virtual void	EnterGrayoutMode ()=0
	Enter gray out mode. More...

virtual void	ExitGrayoutMode ()=0
	Exit gray out mode. More...

virtual bool	IsGrayoutMode () const =0
	is gray out mode More...

virtual void	EnterDuplicateMode ()=0

virtual void	ExitDuplicateMode ()=0

virtual bool	IsDuplicateMode () const =0

virtual void	RefreshGraphMatrixContext ()=0

virtual void	SetGMCEContext (void *iGMCEContext)=0

virtual void	RefreshOnDataChange ()=0

virtual Int32	GetSeriesColorFromPalette (Int32 iIndex)=0

virtual bool	IsDataEnough ()=0
	Check whether the data is enough for selected graph type. More...

virtual float	GetMemoryUsageEstimation ()=0
	Get memory usage estimation before drawing. More...

virtual void	SetFontScale (double iRatio=1.0)=0

virtual void	SetTemplateNode (DSSRWTemplateNode *ipTemplateNode)=0

virtual double	GetPositionAtTick (double iTickValue, bool iIsForXAxis, Int32 iGraphDimentionLength)=0

virtual void	SetEntireness (bool iIsEntireChart)=0

virtual Int32	GetIntervalSpace (bool iIsXAxis)=0

virtual bool	IsZeroBaseLineQualified (bool iIsXAxis, bool isSecondaryAxis)=0

virtual Int32	LayoutAxis (bool iIsXAxis, bool iIsRotated, Int32 &orMaxLabelSpace)=0

virtual Int32	GetAxisLabelRotaion (bool iIsXAxis)=0

virtual Int32	GetMaxElementRadius (Int32 iWidth, Int32 iHeight, bool iIsPerfectPadding=false)=0

virtual Int32	GetCachedMaxElementSize ()=0

virtual bool	ShouldRotateDataLabel (Int32 iWidth, Int32 iHeight, bool iIsForPefectPadding=false)=0

virtual bool	ShouldAdjustValueAxis (Int32 iWidth, Int32 iHeight, double &irAdjustedValue, bool iIsForPefectPadding=false)=0

virtual bool	IsIsolatedDot (const TripleId &irId)=0

virtual bool	IsIsolatedDotInLine (const TripleId &irId)=0

virtual bool	GetInterlacedBandingPosition (bool iIsXAxis, std::vector< double > &orPostions, bool iIsFromUniformAxis=true)=0

virtual bool	GetGroupSpace (std::vector< Int32 > &orVect, Int32 iGroupIndex, bool iIsLegned=false)=0

virtual bool	GetSpaceAt (std::vector< Int32 > &orVect, const TripleId &irObjectId)=0

virtual void	DisableAnimationForZoom (bool iDisableAnimation)=0

virtual bool	RefreshChart (const RefreshPack &irRefreshPack)=0

virtual bool	GetDataAreaPadding (std::vector< double > &orPaddings)=0

virtual bool	IsVerticalChart () const =0

virtual void	SetTextAsShape (bool iFlag)=0

virtual void	cleanDataSet ()=0

Member Function Documentation

◆ AddToSelectionList()

virtual bool MsiChart::Chart::AddToSelectionList ( const TripleId & iObject )

pure virtual

This function adds an object into the selection list.

Parameters

iObject Specifies the object.

Returns: True means the object is added into the selection list successfully, and false means the object is already in the selection list.

Implemented in MsiChart::ChartImpl.

◆ AllocSelectionList()

virtual void MsiChart::Chart::AllocSelectionList	(	TripleId *&	orpSelectionList,
		Int32 &	oNum
	)

pure virtual

This function allocate the selection list for the client.

Parameters

orpSelectionList	The pointer to the list of triple ids of those selected graph object.
oNum	The number of the graph object in the list.

Implemented in MsiChart::ChartImpl.

◆ ApplySelectedObjects()

virtual int MsiChart::Chart::ApplySelectedObjects	(	Int32	iX,
		Int32	iY,
		std::vector< Point2D > &	iPoints,
		Point2D &	ioPoint
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ CanShowTooltipById()

virtual bool MsiChart::Chart::CanShowTooltipById ( TripleId & irId ) const

pure virtual

If we can show tooltip for a graph object at the specified tripleId.

Parameters

irId,the object tripleId

Returns: TRUE means we can show tooltip for this object.

Implemented in MsiChart::ChartImpl.

◆ cleanDataSet()

virtual void MsiChart::Chart::cleanDataSet ( )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ ClearOneHighlightObject()

virtual bool MsiChart::Chart::ClearOneHighlightObject ( MsiChart::TripleId iTripleId )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ ClearSelectionList()

virtual void MsiChart::Chart::ClearSelectionList ( )

pure virtual

This function clear the selection list.

Implemented in MsiChart::ChartImpl.

◆ CreateTooltipByObject() [1/2]

virtual Int32 MsiChart::Chart::CreateTooltipByObject	(	TripleId *	ipSelectionList,
		Int32	iNum,
		std::vector< Tooltip *> &	orTooltips,
		bool	iPersistent = `false`
	)

pure virtual

Get tooltip by passing the corresponding tripleId list.

Parameters

ipSelectionList,the	list containing the IDs to search for tooltips
iNum,the	number of elements in ipSelectionList
orTooltips,the	returned list of tooltips
iPersisitent	if set as true, the property setting "DssGraphSDShowTooltip" will be ignored.

Returns: Return the size of orTooltips

Implemented in MsiChart::ChartImpl.

◆ CreateTooltipByObject() [2/2]

virtual Int32 MsiChart::Chart::CreateTooltipByObject	(	const std::vector< TripleId > &	irSelectionList,
		std::vector< Tooltip *> &	orTooltips,
		bool	iPersistent = `false`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ CreateToolTipBySeriesAndGroup()

virtual Tooltip* MsiChart::Chart::CreateToolTipBySeriesAndGroup	(	Int32	iSeriesID,
		Int32	iGroupID,
		bool	iPersistent = `false`
	)

pure virtual

This function is to Create a tooltip by series ID and group ID. The caller is responsible to delete it.

Parameters

iSeriesID	Specifies the series id.
iGroupID	Specifies the group id.
iPersistent	if set as true, then the property DssGraphSDShowTooltip will be ignored.

Returns: Return a tooltip is created. Otherwise, return NULL.

Implemented in MsiChart::ChartImpl.

◆ Delete()

virtual void MsiChart::Chart::Delete ( )

pure virtual

This function deletes the Chart instance.

Implemented in MsiChart::ChartImpl.

◆ DeviceToVirtualPoint()

virtual void MsiChart::Chart::DeviceToVirtualPoint	(	Int32 &	iorX,
		Int32 &	iorY
	)		const

pure virtual

This function transform a point in device coordinate to virtual coordinate.

Parameters

iorX	Specifies x coordinate of the point.
iorY	Specifies y coordinate of the point.

Implemented in MsiChart::ChartImpl.

◆ DisableAnimationForZoom()

virtual void MsiChart::Chart::DisableAnimationForZoom ( bool iDisableAnimation )

pure virtual

Zoom spec, if the charts are generated right after zoom, animation should be disabled.

Parameters

iDisableAnimation,true means animation should be disabled.

Implemented in MsiChart::ChartImpl.

◆ DisposeSelectionList()

virtual void MsiChart::Chart::DisposeSelectionList ( TripleId * ipSelectionList )

pure virtual

This function free the selection list allocated by AllocSelectionList().

Implemented in MsiChart::ChartImpl.

◆ DrawDataAreaForUniformAxis()

virtual void MsiChart::Chart::DrawDataAreaForUniformAxis	(	CGContext *	ipCGContext,
		Int32	iWidth,
		Int32	iHeight
	)

pure virtual

This method should only be called when uniform axis is enabled. This method should be called after GetUniformYAxisWidth() and GetUniformXAxisHeight() are called. This method draws X axis labels to a give CGContext.

Parameters

ipCGContest	Speicfies a core graphics context.
iWidth,iHeight	Specifies the image size for X axis labels. PS: If you want to draw the entire chart, please call SaveImageToCGContext().

Implemented in MsiChart::ChartImpl.

◆ DrawUniformXAxis()

virtual void MsiChart::Chart::DrawUniformXAxis	(	CGContext *	ipCGContext,
		Int32	iWidth,
		Int32	iHeight,
		bool	iIsForSecondaryAxis = `false`
	)

pure virtual

This method should only be called when uniform axis is enabled. This method should be called after GetUniformYAxisWidth() and GetUniformXAxisHeight() are called. This method draws X axis labels to a give CGContext.

Parameters

ipCGContest	Speicfies a core graphics context.
iWidth,iHeight	Specifies the image size for X axis labels. PS: If you want to draw the entire chart, please call SaveImageToCGContext().

Implemented in MsiChart::ChartImpl.

◆ DrawUniformYAxis()

virtual void MsiChart::Chart::DrawUniformYAxis	(	CGContext *	ipCGContext,
		Int32	iWidth,
		Int32	iHeight,
		bool	iIsForSecondaryAxis = `false`
	)

pure virtual

This method should only be called when uniform axis is enabled. This method should be called after GetUniformYAxisWidth() and GetUniformXAxisHeight() are called. This method draws Y axis labels to a give CGContext.

Parameters

ipCGContest	Speicfies a core graphics context.
iWidth,iHeight	Specifies the image size for Y axis labels. PS: If you want to draw the entire chart, please call SaveImageToCGContext().

Implemented in MsiChart::ChartImpl.

◆ EnableAnimation()

virtual void MsiChart::Chart::EnableAnimation ( bool iUseAnimation )

pure virtual

Enable or disable animation.

Parameters

iUseAnimation Indicates whether animation is needed or not.

Implemented in MsiChart::ChartImpl.

◆ EnableGraphMatrix()

virtual void MsiChart::Chart::EnableGraphMatrix ( bool iIsGraphMatrix )

pure virtual

Enable or disable graph matrix.

Parameters

iIsGraphMatrix Specifies whether current chart is a graph matrix or not.

Implemented in MsiChart::ChartImpl.

◆ EnableMicroChart()

virtual void MsiChart::Chart::EnableMicroChart ( bool iIsMicroChart )

pure virtual

Enable or disable macro chart.

Parameters

iIsMicroChart Specifies whether current chart is a micro chart or not.

Implemented in MsiChart::ChartImpl.

◆ EnableTimeSeriesChart()

virtual void MsiChart::Chart::EnableTimeSeriesChart ( bool iIsTimeSeriesChart )

pure virtual

Enable or disable time series chart.

Parameters

iIsTimeSeriesChart Specifies whether current chart is a time series chart or not.

Implemented in MsiChart::ChartImpl.

◆ EnableUniformAxis()

virtual void MsiChart::Chart::EnableUniformAxis	(	GraphMatrixMinMaxInfo	yMinMaxInfo,
		GraphMatrixMinMaxInfo	xMinMaxInfo,
		GraphMatrixMinMaxInfo	zMinMaxInfo,
		Int32	iGraphHeight,
		GraphMatrixMinMaxInfo	y2MinMaxInfo = `std::make_pair(-1, std::make_pair(0.0, 0.0))`,
		GraphMatrixMinMaxInfo	x2MinMaxInfo = `std::make_pair(-1, std::make_pair(0.0, 0.0))`
	)

pure virtual

Enable uniform axis for graph matrix.

Parameters

i{XZ}MinValue,i{XZ}MaxValue	Specifies a value range from dataset for Y, X, Z axis.
iGraphHeight	Specifies a rough estimation on graph height. This parameter is used to get relative font size in zoom out mode. In zoom in mode, this parameter is ignored.

Implemented in MsiChart::ChartImpl.

◆ EnableVIDocument()

virtual void MsiChart::Chart::EnableVIDocument ( bool iIsVIDocument )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ EnableVoiceOver()

virtual void MsiChart::Chart::EnableVoiceOver ( bool iIsVoiceOverMode )

pure virtual

Enable or disable voice over.

Parameters

iIsVoiceOverMode Specifies whether current chart is for voice over mode.

Implemented in MsiChart::ChartImpl.

◆ EnterDuplicateMode()

virtual void MsiChart::Chart::EnterDuplicateMode ( )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ EnterGrayoutMode()

virtual void MsiChart::Chart::EnterGrayoutMode ( )

pure virtual

Enter gray out mode.

Implemented in MsiChart::ChartImpl.

◆ ExitDuplicateMode()

virtual void MsiChart::Chart::ExitDuplicateMode ( )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ ExitGrayoutMode()

virtual void MsiChart::Chart::ExitGrayoutMode ( )

pure virtual

Exit gray out mode.

Implemented in MsiChart::ChartImpl.

◆ GenerateImageMap()

virtual bool MsiChart::Chart::GenerateImageMap	(	Int32	iWidth,
		Int32	iHeight,
		ImageMap &	oImageMap
	)

pure virtual

This function generates image map for the web client.

Parameters

iWidth	Width in pixels.
iHeight	Height in pixels.
oImageMap	Output to store the generated image map.

Returns: True means the image map is generated successfully, and false means not.

Implemented in MsiChart::ChartImpl.

◆ GetAllGraphObjectInfo()

virtual void MsiChart::Chart::GetAllGraphObjectInfo	(	std::vector< CGRect > &	iAllGraphObjectsBorder,
		std::vector< MsiChart::TripleId > &	iAllGraphObjectsTripleId
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetAllObjectsWithInDistance()

virtual bool MsiChart::Chart::GetAllObjectsWithInDistance	(	Int32	iX,
		Int32	iY,
		const std::vector< Int32 > &	irObjectIds,
		Int32	iRadius,
		std::vector< SelectedInfo > &	orNearObjects,
		std::vector< Int32 > &	orDistance
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetAxisLabelRotaion()

virtual Int32 MsiChart::Chart::GetAxisLabelRotaion ( bool iIsXAxis )

pure virtual

To see how the axis labels are rotated, used in Graph matrix mode. , true means the uniform x axis.

Returns: the rotated mode.

Implemented in MsiChart::ChartImpl.

◆ GetAxisNumberFormat()

virtual void MsiChart::Chart::GetAxisNumberFormat ( CComVariant * opValue ) const

pure virtual

This function gets the auto number format for the value axis.

Parameters

opValue Output the number format in a string.

Implemented in MsiChart::ChartImpl.

◆ GetCachedMaxElementSize()

virtual Int32 MsiChart::Chart::GetCachedMaxElementSize ( )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetCategoryAxisLabelInterval()

virtual Int32 MsiChart::Chart::GetCategoryAxisLabelInterval ( )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetChartAreaId()

virtual Int32 MsiChart::Chart::GetChartAreaId ( const TripleId & iObject )

pure virtual

This function is a helper function for the client side. Given a triple id, the function return the id of the chart area which the graph object with the triple id belongs to.

Parameters

iObject Specifies the object.

Returns: The id of the chart area that the graph object belongs to.

Implemented in MsiChart::ChartImpl.

◆ GetData()

virtual Dataset::Ptr MsiChart::Chart::GetData ( )

pure virtual

This method is to get the dataset.

Returns: The dataset.

Implemented in MsiChart::ChartImpl.

◆ GetDataAreaPadding()

virtual bool MsiChart::Chart::GetDataAreaPadding ( std::vector< double > & orPaddings )

pure virtual

Graph Matrix, to get the four paddings around the data area for each mini-chart.

Parameters

orPaddings,the result padding set. It is put in the following sequence: <xLow, xHigh, yLow, yHigh.>

Returns: true means getting padding is done with success.

Implemented in MsiChart::ChartImpl.

◆ GetDataAreaSplitX()

virtual Int32 MsiChart::Chart::GetDataAreaSplitX ( ) const

pure virtual

Get the x-coordinate of the data area origin

Implemented in MsiChart::ChartImpl.

◆ GetDataAreaSplitY()

virtual Int32 MsiChart::Chart::GetDataAreaSplitY ( ) const

pure virtual

Get the y-coordinate of the data area origin

Implemented in MsiChart::ChartImpl.

◆ GetDataGroup()

virtual Int32 MsiChart::Chart::GetDataGroup ( bool & orIgnoreForNoSeriesOrGroup ) const

pure virtual

This function gets the data group. orIgnoreForNoSeriesOrGroup, decide how we should group insufficient data.

Returns: The data group.

Implemented in MsiChart::ChartImpl.

◆ GetDataPointForUIMenu()

virtual int MsiChart::Chart::GetDataPointForUIMenu	(	Int32	iX,
		Int32	iY,
		Tooltip &	ioTooltip,
		bool	iLSMode = `false`
	)

pure virtual

This function provides zero or more tooltips for input coordinates.

Parameters

iX	Specifies the x coordinate of the provided point. The point coordinate is device coordinate.
iY	Specifies the y coordinate of the provided point.
ioPoint	Output data point for the menu controller.

Implemented in MsiChart::ChartImpl.

◆ GetGraphHeight()

virtual Int32 MsiChart::Chart::GetGraphHeight ( ) const

pure virtual

This function gets the graph height.

Returns: The graph height.

Implemented in MsiChart::ChartImpl.

◆ GetGraphType()

virtual void MsiChart::Chart::GetGraphType ( short & orGraphType )

pure virtual

This function gets the graph type.

Parameters

orGraphType The output graph type.

Implemented in MsiChart::ChartImpl.

◆ GetGraphWidth()

virtual Int32 MsiChart::Chart::GetGraphWidth ( ) const

pure virtual

This function gets the graph width.

Returns: The graph width.

Implemented in MsiChart::ChartImpl.

◆ GetGroupIntervalInPixel()

virtual double MsiChart::Chart::GetGroupIntervalInPixel ( )

pure virtual

Get group interval of category axis in pixel.

Returns: Return the group interval in pixel.

Implemented in MsiChart::ChartImpl.

◆ GetGroupLabel()

virtual void MsiChart::Chart::GetGroupLabel	(	Int32	iGroupId,
		MBase::String &	orGroupLabel,
		const wchar_t	iSeparator,
		bool	iIsAbbreviated
	)

pure virtual

Get group label by group ID.

Parameters

iGroupId	Specifies a group ID in dataset slice context.
orGroupLabel	Output a group label.
iSeparator	Specifies the separator between adjacent elements. Only useful when tree structure is available in dataset.
iIsAbbreviated	Indicate whether the group label should be abbreviated. Only useful when tree structure is available in dataset.

Implemented in MsiChart::ChartImpl.

◆ GetGroupSpace()

virtual bool MsiChart::Chart::GetGroupSpace	(	std::vector< Int32 > &	orVect,
		Int32	iGroupIndex,
		bool	iIsLegned = `false`
	)

pure virtual

Both functions retuns the size information for a specific area/object

Parameters

orVect,returned	information in terms of <x,y, w, h>
iGroupIndex,the	area for the indicated group.
iIsLegend,denote	if we are getting the area for legend.
irObjectId,the	target object to search for size information.

Returns: Return true if the result is valid.

Implemented in MsiChart::ChartImpl.

◆ GetHighlightObjects() [1/2]

virtual void MsiChart::Chart::GetHighlightObjects ( std::vector< std::pair< Int32, Int32 > > & orHighlightObjects ) const

pure virtual

Get the <seriesId, groupId> pairs of objects that are highlighted.

Parameters

orHighlightObjects,the result <seriesId, groupId> pairs.

Returns: void.

Implemented in MsiChart::ChartImpl.

◆ GetHighlightObjects() [2/2]

virtual void MsiChart::Chart::GetHighlightObjects ( std::vector< MsiChart::TripleId > & orHighlightObjects ) const

pure virtual

◆ GetHoveredLineObject()

virtual bool MsiChart::Chart::GetHoveredLineObject	(	TripleId &	orHoveredLineObject,
		Int32	iIndex = `0`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetHoveredObject()

virtual bool MsiChart::Chart::GetHoveredObject	(	TripleId &	orHoveredObject,
		Int32	iIndex = `0`
	)

pure virtual

To Get the triple Id of the hoved object, the 2nd parameter is left for futher enhancement.

Returns: the tripleId of the hovered object.

Implemented in MsiChart::ChartImpl.

◆ GetInterlacedBandingPosition()

virtual bool MsiChart::Chart::GetInterlacedBandingPosition	(	bool	iIsXAxis,
		std::vector< double > &	orPostions,
		bool	iIsFromUniformAxis = `true`
	)

pure virtual

To get the position of the banding into charts. used in Graph matrix , is X axis or not. , the results for banding postions.

Returns: true if we get the result with success.

Implemented in MsiChart::ChartImpl.

◆ GetIntervalSpace()

virtual Int32 MsiChart::Chart::GetIntervalSpace ( bool iIsXAxis )

pure virtual

RR, to get the space for one interval along the specified numeric axis, if it is not numberic, return 0

Parameters

iIsXAxis,wether this computation is on x axis.

Returns: : the space for one interval along the denoted axis.

Implemented in MsiChart::ChartImpl.

◆ GetLastGroupId()

virtual Int32 MsiChart::Chart::GetLastGroupId ( )

pure virtual

Get the last group ID which is shown in current graph.

Returns: Return the last group ID.

Implemented in MsiChart::ChartImpl.

◆ GetMaxElementRadius()

virtual Int32 MsiChart::Chart::GetMaxElementRadius	(	Int32	iWidth,
		Int32	iHeight,
		bool	iIsPerfectPadding = `false`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetMemoryUsageEstimation()

virtual float MsiChart::Chart::GetMemoryUsageEstimation ( )

pure virtual

Get memory usage estimation before drawing.

Implemented in MsiChart::ChartImpl.

◆ GetNearestObject()

virtual bool MsiChart::Chart::GetNearestObject	(	Int32	iX,
		Int32	iY,
		const std::vector< Int32 > &	irObjectIds,
		Int32	iRadius,
		TripleId &	orNearestTripleId,
		int *	opNearestDistance = `NULL`
	)

pure virtual

Return the nearest virtual marker's tripleId. For Time Series.

Parameters

iX	Specifies the x coordinate of the provided point.
iY	Specifies the y coordinate of the provided point.
irObjectIds	Specifies a list of candidate object IDs.
iRadius	Specifies the distance within which to detect object.
orNearestTripleId	the nearest object's tripleId.

Returns: True if there is an object found.

Implemented in MsiChart::ChartImpl.

◆ GetNearestObjectForGMCombo()

virtual bool MsiChart::Chart::GetNearestObjectForGMCombo	(	Int32	iX,
		Int32	iY,
		const std::vector< Int32 > &	irObjectIds,
		Int32	iRadius,
		TripleId &	orNearestTripleId,
		int *	opNearestDistance
	)

pure virtual

Return those objects with distance between input point (iX, iY) smaller than iRadius.

Parameters

iX	Specifies the x coordinate of the provided point.
iY	Specifies the y coordinate of the provided point.
irObjectIds	Specifies a list of candidate object IDs.
iRadius	Specifies the distance within which to detect object.

Returns: True if there is an object found.

Implemented in MsiChart::ChartImpl.

◆ GetNumOfSelectedObjects()

virtual int MsiChart::Chart::GetNumOfSelectedObjects ( )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetOptions()

virtual bool MsiChart::Chart::GetOptions	(	Int32	iObjectId,
		Int32	iSeriesId,
		Int32	iGroupId,
		Int32	iPropertyId,
		CComVariant *	opValue
	)

pure virtual

This function gets the property specified by PropertyId and store the property information at opValue

Parameters

iObjectId	Identifies the object. Use NULL_OBJECTID if there is no object associated with the property or the property is object-specific.
iSeriesId	Identifies the series number when changing properties that only apply to a specific series. Use NULL_SERIESID if there is no series number associated with the property.
iGroupId	Identifies the group number when changing properties that only apply to a specific group. Use NULL_GROUPID if there is no group number associated with the property.
iPropertyId	Identifies the property to get.
opValue	Pointer to location to store the property value

Returns: indicates the result of the request. True means property value successfully returned while false means failing to get the property value correctly.

Implemented in MsiChart::ChartImpl.

◆ GetPieSliceTooltipDataString()

virtual bool MsiChart::Chart::GetPieSliceTooltipDataString	(	Int32	iSeriesID,
		Int32	iGroupID,
		Int32	iAngleID,
		Int32	iSliceID,
		Int32	iColumnOffset,
		MBase::String &	orDataString
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetPositionAtTick()

virtual double MsiChart::Chart::GetPositionAtTick	(	double	iTickValue,
		bool	iIsForXAxis,
		Int32	iGraphDimentionLength
	)

pure virtual

GM to get the 0-based line.

Parameters

iTickValue,the	value of the tick.
iIsForXAxis,wether	this computation is on x axis. iGraphDimentionLength, when iIsForXAxis is true, this one should be graph width otherwise it should be height.

Returns: : the position of that tick.

Implemented in MsiChart::ChartImpl.

◆ GetPositionById()

virtual bool MsiChart::Chart::GetPositionById	(	Int32	iSeriesId,
		Int32	iGroupId,
		Int32 &	orX,
		Int32 &	orY
	)

pure virtual

Get position by Series ID and Group ID.

Parameters

iSeriesId,iGroupId	Specifies a Series ID and a Group ID.
orX,orY	If a graph object is found for the given IDs, output the position for that graph object.

Returns: Return true if a graph object is found for the given IDs. Otherwise, return false.

Implemented in MsiChart::ChartImpl.

◆ GetPrimaryDataString()

virtual bool MsiChart::Chart::GetPrimaryDataString	(	Int32	iSeriesID,
		Int32	iGroupID,
		MBase::String &	orDataString,
		bool	iIsForColor,
		Int32	iSizebyIndex = `0`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetPrimaryDataStringForPie()

virtual bool MsiChart::Chart::GetPrimaryDataStringForPie	(	Int32	iSeriesId,
		Int32	iGroupID,
		MBase::String &	orDataString,
		bool	iIsForColor,
		Int32	iColumnOffset = `0`,
		bool	isPercentValue = `false`,
		Int32	iAngleIndex = `-3`,
		Int32	iSlcieIndex = `-3`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetRowAndColumnIndexByCoords()

virtual bool MsiChart::Chart::GetRowAndColumnIndexByCoords	(	int	iX,
		int	iY,
		int &	orRowIndex,
		int &	orColumnIndex,
		bool	iIsDataCellOnly,
		int	iDistance = `-1`
	)

pure virtual

Get the label informatin for the uniform axis, used in iPad Graph Matrix for axis label tooltip
Get row and column indices by coordinates of touch point.

Parameters

iX,iY	Specifies the coordinates of touch point.
orRowIndex,orColumnIndex	Output row and column indices if a riser or data marker is found.

Returns: Return true if a riser or data marker is found for the input touch point.

Implemented in MsiChart::ChartImpl.

◆ GetSeriesColorFromPalette()

virtual Int32 MsiChart::Chart::GetSeriesColorFromPalette ( Int32 iIndex )

pure virtual

This function get series color from a default color palette

Implemented in MsiChart::ChartImpl.

◆ GetSeriesLabel()

virtual void MsiChart::Chart::GetSeriesLabel	(	Int32	iSeriesID,
		MBase::String &	orSeriesLabel,
		bool	iSubstitute = `true`,
		Int32	iColumnOffset = `0`,
		bool	iIsForSlice = `true`
	)

pure virtual

Get series label by group ID.

Parameters

iGroupId	Specifies a group ID in dataset slice context.
orGroupLabel	Output a group label.
iSeparator	Specifies the separator between adjacent elements. Only useful when tree structure is available in dataset.
iIsAbbreviated	Indicate whether the group label should be abbreviated. Only useful when tree structure is available in dataset.

Implemented in MsiChart::ChartImpl.

◆ GetShownNumericTicks()

virtual void MsiChart::Chart::GetShownNumericTicks	(	std::set< double > &	orTicksSet,
		bool	iIsForXAxis
	)

pure virtual

To Get the shown value axis ticks for uniform axis

Parameters

orTicksSet,the	set to hold the results
iIsForXAxis,which	value axis we are getting informatin from

Implemented in MsiChart::ChartImpl.

◆ GetSOByLassoSelection()

virtual void MsiChart::Chart::GetSOByLassoSelection ( std::vector< std::pair< int, int > > & iObjects )

pure virtual

Get Selected Objects by Lasso Selections.

Implemented in MsiChart::ChartImpl.

◆ GetSpaceAt()

virtual bool MsiChart::Chart::GetSpaceAt	(	std::vector< Int32 > &	orVect,
		const TripleId &	irObjectId
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetStaggerLabelEndLevel()

virtual void MsiChart::Chart::GetStaggerLabelEndLevel ( Int32 & orLabelEndLevel )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetToolTipByCoords() [1/2]

virtual unsigned Int32 MsiChart::Chart::GetToolTipByCoords	(	Int32	iX,
		Int32	iY,
		std::vector< Tooltip *> &	orTooltips,
		bool	iPersistent = `false`
	)

pure virtual

This function provides zero or more tooltips for input coordinates.

Parameters

iX	Specifies the x coordinate of the provided point. The point coordinate is device coordinate.
iY	Specifies the y coordinate of the provided point.
orTooltips	Output tooltips.
iPersisitent	if set as true, the property setting "DssGraphSDShowTooltip" will be ignored.
Int32	iDetectiveRadius, objects falls inside this radius will be collected.

Returns: Return the number of tooltips in orTooltips.

Implemented in MsiChart::ChartImpl.

◆ GetToolTipByCoords() [2/2]

virtual unsigned Int32 MsiChart::Chart::GetToolTipByCoords	(	Int32	iX,
		Int32	iY,
		std::vector< Tooltip *> &	orTooltips,
		Int32	iDetectiveRadius,
		bool	iPersistent = `false`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetToolTipData()

virtual bool MsiChart::Chart::GetToolTipData	(	Int32	iSeriesID,
		Int32	iGroupID,
		double &	orValue,
		double &	orPercentValue,
		Int32	iOffset = `0`
	)

pure virtual

This function is to get the displayed data value used for tooltip.

Parameters

iSeriesID	Specifies the series id.
iGroupID	Specifies the group id.
orValue	Outputs the dislayed data value.
orPercentValue	Outputs the displayed percentage data value.
iOffset	Distinguishes multi-data points, such as scatter where the flags would have different values for XVALUE, YVALUE and so on for other charts

Implemented in MsiChart::ChartImpl.

◆ GetToolTipDataString() [1/2]

virtual bool MsiChart::Chart::GetToolTipDataString	(	Int32	iSeriesID,
		Int32	iGroupID,
		MBase::String &	orDataString,
		Int32	iOffset = `0`
	)

pure virtual

This function is to get the displayed data value used for tooltip.

Parameters

iSeriesID	Specifies the series id.
iGroupID	Specifies the group id.
orDataString	Outputs the data string for display.
iOffset	Distinguishes multi-data points, such as scatter where the flags would have different values for XVALUE, YVALUE and so on for other charts

Implemented in MsiChart::ChartImpl.

◆ GetToolTipDataString() [2/2]

virtual bool MsiChart::Chart::GetToolTipDataString	(	Int32	iSeriesID,
		Int32	iGroupID,
		MBase::String &	orDataString,
		MBase::String &	orPercentDataString,
		Int32	iOffset = `0`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ GetUniformAxisMargins()

virtual void MsiChart::Chart::GetUniformAxisMargins	(	short &	orLeftMargin,
		short &	orRightMargin,
		short &	orTopMargin,
		short &	orBottomMargin,
		bool	iIsForSecondaryAxis = `false`
	)

pure virtual

This method should only be called when uniform axis is enabled.
This method gets the margins around data area. Before calling this metohd, GetUniformYAxisWidth() and GetUniformXAxisHeight() should be called.

Parameters

orLeftMargin,orRightMargin,orTopMargin,orBottomMargin Output margin info around data area. Use these margins to SetUniformAxisInfo() for other chart instances.

Implemented in MsiChart::ChartImpl.

◆ GetUniformXAxisHeight()

virtual Int32 MsiChart::Chart::GetUniformXAxisHeight	(	Int32	iXAxisLength,
		Int32	iMetricIndex = `-1`,
		bool	iIsForSecondaryAxis = `false`
	)

pure virtual

This method should only be called when uniform axis is enabled. This method gets X axis width in uniform axis mode. For graph matrix, we assume that X axis is always a category axis.

Parameters

iXAxisLength	Specifies X axis length. X axis may have less labels for Int32er axis length.
iMetricIndex	Specifies the metric index that hosts this axis, it only works when the axis is under only one metric and the axis itself is value axis. By default it is -1. It is better to call GetUniformYAxisWidth() before calling this method so that X axis length can be calculated based on Y axis width.

Returns: Return X axis width.

Implemented in MsiChart::ChartImpl.

◆ GetUniformYAxisWidth()

virtual Int32 MsiChart::Chart::GetUniformYAxisWidth	(	Int32	iYAxisLength,
		Int32	iMetricIndex = `-1`,
		bool	iIsForSecondaryAxis = `false`
	)

pure virtual

This method should only be called when uniform axis is enabled. This method gets Y axis width in uniform axis mode. For graph matrix, we assume that Y axis is always a value axis.

Parameters

iYAxisLength	Specifies a rough estimation on Y axis length. Y axis may have less labels for Int32er axis length.
iMetricIndex	Specifies the metric index that hosts this axis, it only works when the axis is under only one metric and the axis itself is value axis. By default it is -1.

Returns: Return Y axis width.

Implemented in MsiChart::ChartImpl.

◆ HideAxisElements()

virtual void MsiChart::Chart::HideAxisElements ( bool iHide )

pure virtual

Specify whether axis elements should be hidden.

Parameters

iHide,true means to hide.

Implemented in MsiChart::ChartImpl.

◆ HighlightOrHideObjects()

virtual void MsiChart::Chart::HighlightOrHideObjects	(	const std::vector< TripleId > &	irTripleIds,
		bool	iIsHide
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ HighlightOrHideOneObject()

virtual void MsiChart::Chart::HighlightOrHideOneObject	(	const TripleId	irTripleId,
		bool	iIsHide
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ HighlightSelectedInInit()

virtual void MsiChart::Chart::HighlightSelectedInInit ( std::vector< std::pair< Int32, Int32 > > & iSelectedSeriesAndColumns )

pure virtual

Highlight selected object when the graph document is opened.

Implemented in MsiChart::ChartImpl.

◆ HighlightSelectedObject()

virtual void MsiChart::Chart::HighlightSelectedObject	(	bool	iHighlight,
		bool	iIsForLassoSelction = `false`
	)

pure virtual

Highlight selected object.

Implemented in MsiChart::ChartImpl.

◆ IsDataEnough()

virtual bool MsiChart::Chart::IsDataEnough ( )

pure virtual

Check whether the data is enough for selected graph type.

Implemented in MsiChart::ChartImpl.

◆ IsDrillableLabelAtCoords()

virtual bool MsiChart::Chart::IsDrillableLabelAtCoords	(	int	iX,
		int	iY,
		std::string &	orLinkURL
	)

pure virtual

Decide if the coords is for a graph axis label and if this label is drillable.

Parameters

iX,iY	Specifies the coordinates of touch point.
iorLinkURL,if	it is drillable, the link will be stored here.

Returns: Return true if the (iX, iY) is for a graph axis label and this label is drillabel, and false otherwise.

Implemented in MsiChart::ChartImpl.

◆ IsDuplicateMode()

virtual bool MsiChart::Chart::IsDuplicateMode ( ) const

pure virtual

Implemented in MsiChart::ChartImpl.

◆ IsGrayoutMode()

virtual bool MsiChart::Chart::IsGrayoutMode ( ) const

pure virtual

is gray out mode

Implemented in MsiChart::ChartImpl.

◆ IsInitialized()

virtual bool MsiChart::Chart::IsInitialized ( ) const

pure virtual

If graph tree is ready.

Returns: true means graph tree is already built for rendering.

Implemented in MsiChart::ChartImpl.

◆ IsInSelectionList()

virtual bool MsiChart::Chart::IsInSelectionList ( const TripleId & iObject )

pure virtual

This function tells whether an object is in the selection list or not.

Parameters

iObject Specifies the object.

Returns: True means the object is in the selection list, and false means not.

Implemented in MsiChart::ChartImpl.

◆ IsIsolatedDot()

virtual bool MsiChart::Chart::IsIsolatedDot ( const TripleId & irId )

pure virtual

To see if one object with the input iSeriesId iGroupId is an isolated dot.

Parameters

irId,the input object id to test.

Returns: TRUE means this is an isolated dot and false otherwise.

Implemented in MsiChart::ChartImpl.

◆ IsIsolatedDotInLine()

virtual bool MsiChart::Chart::IsIsolatedDotInLine ( const TripleId & irId )

pure virtual

To see if one object with the input iSeriesId iGroupId is an isolated dot in line chart.

Implemented in MsiChart::ChartImpl.

◆ IsVerticalChart()

virtual bool MsiChart::Chart::IsVerticalChart ( ) const

pure virtual

If this chart is a vertically lay-out chart.

Returns: TRUE means a vertical chart and false otherwise.

Implemented in MsiChart::ChartImpl.

◆ IsZeroBaseLineQualified()

virtual bool MsiChart::Chart::IsZeroBaseLineQualified	(	bool	iIsXAxis,
		bool	isSecondaryAxis
	)

pure virtual

RR, to decide if we need zero base line, this should only be called for bar chart case.

Parameters

iIsXAxis,wether this computation is on x axis.

Returns: : true means we can draw zero base line.

Implemented in MsiChart::ChartImpl.

◆ LayoutAxis()

virtual Int32 MsiChart::Chart::LayoutAxis	(	bool	iIsXAxis,
		bool	iIsRotated,
		Int32 &	orMaxLabelSpace
	)

pure virtual

To layout the axis in "Fit to Content" mode.

Returns: the total length/height of this axis. , x-axis or y-axis to layout, if it is y axis, no need to consider iIsRotated, since the labels will always be horizontally placed. , if the labels should be rotated, useful when it is x-axis. , the max space taken by one single label, if it is rotated, this is a fixed value.

Implemented in MsiChart::ChartImpl.

◆ OnHover() [1/3]

virtual bool MsiChart::Chart::OnHover	(	Int32	iX,
		Int32	iY
	)

pure virtual

To highlight graph object(s) at (ix, iy)

Returns: true means the hover is successful.

Implemented in MsiChart::ChartImpl.

◆ OnHover() [2/3]

virtual bool MsiChart::Chart::OnHover	(	Int32	iX,
		Int32	iY,
		Int32	iDistance
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ OnHover() [3/3]

virtual bool MsiChart::Chart::OnHover ( const TripleId & irHoverObject )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ OnPointDetection()

virtual bool MsiChart::Chart::OnPointDetection	(	Int32	iX,
		Int32	iY,
		bool	iSmartSelection,
		TripleId &	orSelectedObject
	)

pure virtual

This function provides the point hit test detection service. Provided some coordinate (x, y), this function can tell the object containing that point or the parent object of the selected object by the same parameter oSelectedObject. Whether return the selected object itself or the parent object is decided by the parameter iSmartSelection. For example, in a Bar graph, when I click on one riser this function could return the triple id of the selected riser or the triple id of the series containing this riser. In this case the whole series that contains the selected riser will be identified by one triple id and regarded as the "parent object" of the selected riser.

Parameters

iX	Specifies the x coordinate of the provided point. The point coordinate is device coordinate.
iY	Specifies the y coordinate of the provided point.
iSmartSelection	Indicates whether the selected object or the parent object should be returned. False means the selected object will be returned, and true means the parent object will be returned.
oSelectedObject	To store the triple id of the selected object or the parent object.

Returns: True means the selected object could be resized and moved, and false means the selected object could NOT be resized and moved.

Implemented in MsiChart::ChartImpl.

◆ OnRectangleSelection()

virtual bool MsiChart::Chart::OnRectangleSelection	(	Int32	iLeft,
		Int32	iTop,
		Int32	iWidth,
		Int32	iHeight,
		bool	iSmartSelection,
		TripleId *&	orpSelectionList,
		Int32 &	oNum
	)

pure virtual

This function provides the rectangle hit test detection service. Provided a bounding rectangle (x, y, width, height), this function can tell all the object inside that area by the parameter oSelectedObjects.

Parameters

iLeft	Specifies the x coordinate of the left top point of the provided rectangle. The rectangle coordinate is device coordinate.
iTop	Specifies the y coordinate of the left top point of the provided rectangle.
iSmartSelection	Indicates whether the selected objects or the parent objects should be returned. False means the selected objects will be returned, and true means the parent objects will be returned
oSelectedObjects	To store the triple ids of the selected object or the parent objects.

Returns: True means the selected object could be resized and moved, and false means the selected object could NOT be resized and moved.

Implemented in MsiChart::ChartImpl.

◆ OnSwipingInZoom()

virtual void MsiChart::Chart::OnSwipingInZoom	(	Int32	iX,
		Int32	iY
	)

pure virtual

Handles Swiping in zoom state.

Parameters

iX	Specifies the mouse move offset along horizontal direction. The positive direction is right.
iY	Specifies the mouse move offset along vertical direction. The positive direction is down.

Implemented in MsiChart::ChartImpl.

◆ OnSwipingOutOfZoom()

virtual void MsiChart::Chart::OnSwipingOutOfZoom ( Int32 iOffset )

pure virtual

Handles Swiping along category axis.

Parameters

iOffset Specifies the offset of swiping.

Implemented in MsiChart::ChartImpl.

◆ OnZooming()

virtual void MsiChart::Chart::OnZooming	(	Int32	iOldStart,
		Int32	iOldEnd,
		Int32	iNewStart,
		Int32	iNewEnd,
		bool	iIsVertical
	)

pure virtual

Handles zooming event.

Parameters

iOldStart,iOldEnd	Specifies an old range.
iNewStart,iNewEnd	Specifies a new range.
iIsVertical	Indicate whether to zoom vertically or horizontally.

Implemented in MsiChart::ChartImpl.

◆ OnZoomingByGroupRange()

virtual void MsiChart::Chart::OnZoomingByGroupRange	(	double	iStartGroup,
		double	iEndGroup
	)

pure virtual

Handles zooming by applying a new group range.

Parameters

iStartGroup,iEndGroup Specifies a new group range.

Implemented in MsiChart::ChartImpl.

◆ OnZoomRestore()

virtual void MsiChart::Chart::OnZoomRestore ( )

pure virtual

Handles double tap event. Zoom out and render original view.

Implemented in MsiChart::ChartImpl.

◆ PlainDraw()

virtual bool MsiChart::Chart::PlainDraw	(	Int32	iWidth,
		Int32	iHeight
	)

pure virtual

This function calculates and constructs, but does not draw, all graph objects. This function DOES generate selection list.

Parameters

iWidth	Width in pixels.
iHeight	Height in pixels.

Returns: True means all the graph objects and graph object managers are generated and constructed successfully, and false means not.

Implemented in MsiChart::ChartImpl.

◆ RefreshChart()

virtual bool MsiChart::Chart::RefreshChart ( const RefreshPack & irRefreshPack )

pure virtual

Graph Matrix, to refresh chart by changing its Dataset/Axis component.

Parameters

irRefreshPack,the data structure containing information about which component to refresh.

Returns: true means refresh is done with success.

Implemented in MsiChart::ChartImpl.

◆ RefreshGraphMatrixContext()

virtual void MsiChart::Chart::RefreshGraphMatrixContext ( )

pure virtual

This function refresh the graph matirx context. Used in Graph Matrix.

Implemented in MsiChart::ChartImpl.

◆ RefreshOnDataChange()

virtual void MsiChart::Chart::RefreshOnDataChange ( )

pure virtual

This function refresh chart's some internal data structure (like some caches) once the dataset is reset/refreshed

Implemented in MsiChart::ChartImpl.

◆ RemoveFromSelectionList()

virtual bool MsiChart::Chart::RemoveFromSelectionList ( const TripleId & iObject )

pure virtual

This function removes an object from the selection list.

Parameters

iObject Specifies the object.

Returns: True means the object is removed from the selection list successfully, and false means the object is not in the selection list.

Implemented in MsiChart::ChartImpl.

◆ ResetAnimationState()

virtual void MsiChart::Chart::ResetAnimationState ( )

pure virtual

Reset the animation state so that the chart instance could be reused for animation

Implemented in MsiChart::ChartImpl.

◆ ResetGroupRangeAndAxesState()

virtual void MsiChart::Chart::ResetGroupRangeAndAxesState	(	Int32	iBeginGroup,
		Int32	iEndGroup
	)

pure virtual

Reset group range of dataset and axes state.

Parameters

iBeginGroup,iEndGroup Specifes a new group range.

Implemented in MsiChart::ChartImpl.

◆ SaveImageToCGContext()

virtual bool MsiChart::Chart::SaveImageToCGContext	(	CGContext *	ipCGContext,
		Int32	iWidth,
		Int32	iHeight,
		bool	iShowValueAxis = `true`,
		Int32	iImageUsage = `IU_GENERAL`
	)

pure virtual

This function saves the graph to a surface.
This function saves the graph to a core graphics context.

Parameters

ipCGContest	Speicfies a core graphics context.
iWidth,iHeight	Specifies the graph size.
iShowValueAxis	Indicates whether value axis objects needs to be generated or not. The value axis area will be reserved no matter this parameter is true or false.
iImageUsage	Specifies the usage of current image.

Implemented in MsiChart::ChartImpl.

◆ SaveImageToFile()

virtual bool MsiChart::Chart::SaveImageToFile	(	Int32	iWidth,
		Int32	iHeight,
		Int32	iFormat,
		const char *	ipFilename
	)

pure virtual

This function saves the graph to file. The supported image format type should include PNG, BMP, JPEG and PDF.

Parameters

iWidth	Width in pixels.
iHeight	Height in pixels.
iFormat	Export image format. It should PNG, BMP, JPEG and PDF.
iFilename	File Name.

Returns: True means the image is saved to file successfully, and false means failing to save the image to file.

Implemented in MsiChart::ChartImpl.

◆ SaveImageToMemory()

virtual bool MsiChart::Chart::SaveImageToMemory	(	Int32	iWidth,
		Int32	iHeight,
		Int32	iFormat,
		char *&	oprMemory,
		unsigned Int32 &	oSize
	)

pure virtual

This function saves the graph to raw memory. The supported image format type should include PNG, BMP, JPEG and PDF.

Parameters

iWidth	Width in pixels.
iHeight	Height in pixels.
iFormat	Specifies the export image format.
oprMemory	Reference to the pointer to the memory to store the binary image.
oSize	Size of the binary image.

Returns: True means the image is saved to memory successfully, and false means failing to save the image to memory.

Implemented in MsiChart::ChartImpl.

◆ SetAdvancedChartTypeSupport()

virtual void MsiChart::Chart::SetAdvancedChartTypeSupport ( bool iAdvancedChartTypeSupport )

pure virtual

This function specifies whether advanced graph types are supported.

Parameters

iAdvancedChartTypesEnabled is a boolean.

Implemented in MsiChart::ChartImpl.

◆ SetAnimationDuration()

virtual void MsiChart::Chart::SetAnimationDuration ( double iSeconds )

pure virtual

Set the duration of animation.

Parameters

iSeconds Specifies animation duration in seconds.

Implemented in MsiChart::ChartImpl.

◆ SetCategoryAxisLabelInterval()

virtual void MsiChart::Chart::SetCategoryAxisLabelInterval ( Int32 irLabelInterval )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetCGContext()

virtual void MsiChart::Chart::SetCGContext ( CGContext * ipCGContext )

pure virtual

This function should be called before PlainDraw so that we can get the correct text size using this context.

Parameters

ipCGContext The input CGContext pointer

Implemented in MsiChart::ChartImpl.

◆ SetChartComponent()

virtual void MsiChart::Chart::SetChartComponent ( Int32 iChartComponent )

pure virtual

This function sets which component will be generated for the chart, by defautl all will be generated. Static or Dynamic components are the other two choices.

Implemented in MsiChart::ChartImpl.

◆ SetChartOffset()

virtual void MsiChart::Chart::SetChartOffset	(	Int32	iXOffset,
		Int32	iYOffset
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetCurrentGraphFrame()

virtual void MsiChart::Chart::SetCurrentGraphFrame	(	Int32	iX,
		Int32	iY,
		Int32	iWidth,
		Int32	iHeight
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetData()

virtual void MsiChart::Chart::SetData ( Dataset::Ptr iDatasetPtr )

pure virtual

This method is to set the data source for the chart engine.

Parameters

iDatasetPtr The input dataset.

Implemented in MsiChart::ChartImpl.

◆ SetDataAreaSplitX()

virtual void MsiChart::Chart::SetDataAreaSplitX ( Int32 iXCoord )

pure virtual

Set the x-coordinate of the data area origin.

Implemented in MsiChart::ChartImpl.

◆ SetEntireness()

virtual void MsiChart::Chart::SetEntireness ( bool iIsEntireChart )

pure virtual

Speicifies whehter entire chart is needed.

Parameters

iIsEntireChart Speicifies whehter entire chart is needed.

Implemented in MsiChart::ChartImpl.

◆ SetFontScale()

virtual void MsiChart::Chart::SetFontScale ( double iRatio = 1.0 )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetFormatManager()

virtual void MsiChart::Chart::SetFormatManager ( FormatManager::Ptr iFormatManagerPtr )

pure virtual

Set a new FormatManager to current chart.

Implemented in MsiChart::ChartImpl.

◆ SetGMCEContext()

virtual void MsiChart::Chart::SetGMCEContext ( void * iGMCEContext )

pure virtual

This function is to pass the graph matrix context from Widget to chart instance, iGMCEContext is an object-c class, use void*

Implemented in MsiChart::ChartImpl.

◆ SetGMZoomScale()

virtual void MsiChart::Chart::SetGMZoomScale	(	float	iHeightScale,
		float	iWidthScale
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetGraphType()

virtual void MsiChart::Chart::SetGraphType ( short iGraphType )

pure virtual

This function sets the GraphStyle object.

Parameters

iGraphStyleWrapperPtr	The GraphStyle object. This function sets the graph type.
iGraphType	The graph type to set.

Implemented in MsiChart::ChartImpl.

◆ SetGridGraphViewer()

virtual void MsiChart::Chart::SetGridGraphViewer ( void * ipGridGraphViewer )

pure virtual

Pass GridGraphViewer pointer to chart instance. This is for animation support.

Parameters

ipGridGraphViewer GridGraphViewer pointer. The actual type is UIView*. Use void* here since UIView is an Objective-C class.

Implemented in MsiChart::ChartImpl.

◆ SetIsCategoryXAxisForPartialRendering()

virtual void MsiChart::Chart::SetIsCategoryXAxisForPartialRendering ( bool isForPartialRendering )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetOptions()

virtual bool MsiChart::Chart::SetOptions	(	Int32	iObjectId,
		Int32	iSeriesId,
		Int32	iGroupId,
		Int32	iPropertyId,
		CComVariant *	ipValue
	)

pure virtual

This function sets the property specified by PropertyId to the value stored at ipValue.

Parameters

iObjectId	Identifies the object. Use NULL_OBJECTID if there is no object associated with the property or the property is object-specific.
iSeriesId	Identifies the series number when changing properties that only apply to a specific series. Use NULL_SERIESID if there is no series number associated with the property.
iGroupId	Identifies the group number when changing properties that only apply to a specific group. Use NULL_GROUPID if there is no group number associated with the property.
iPropertyId	Identifies the property to set.
ipValue	Pointer to the new property value.

Returns: indicates the result of modifying the property. True means property value successfully changed while false means failing to set the property value correctly.

Implemented in MsiChart::ChartImpl.

◆ SetShowNumbericTicks()

virtual void MsiChart::Chart::SetShowNumbericTicks	(	std::set< double > &	irTicksSet,
		bool	iIsForXAxis
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetStaggerLabelStartLevel()

virtual void MsiChart::Chart::SetStaggerLabelStartLevel ( Int32 irLabelStartLevel )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetTemplateNode()

virtual void MsiChart::Chart::SetTemplateNode ( DSSRWTemplateNode * ipTemplateNode )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetTemplateNodeKey()

virtual void MsiChart::Chart::SetTemplateNodeKey ( const std::string & irKey )

pure virtual

Set the key of corresponding template node. This key can be used for logging.

Parameters

irKey Specifies a template node key.

Implemented in MsiChart::ChartImpl.

◆ SetTextAsShape()

virtual void MsiChart::Chart::SetTextAsShape ( bool iFlag )

pure virtual

Implemented in MsiChart::ChartImpl.

◆ SetTimeSeriesIntegrity()

virtual void MsiChart::Chart::SetTimeSeriesIntegrity ( Int32 iIntegrity )

pure virtual

To set which part of the time series chart should be rendered.

Parameters

iIntegrity,enum from DssTimeSeriesItems

Implemented in MsiChart::ChartImpl.

◆ SetUniformAxisMargins()

virtual void MsiChart::Chart::SetUniformAxisMargins	(	short	iLeftMargin,
		short	iRightMargin,
		short	iTopMargin,
		short	iBottomMargin,
		bool	iIsForSecondaryAxis = `false`
	)

pure virtual

This method should only be called when uniform axis is enabled.

Parameters

iLeftMargin,iRightMargin,iTopMargin,iBottomMargin Set margin info around data area.

Implemented in MsiChart::ChartImpl.

◆ SetXAxisLogicalRange()

virtual void MsiChart::Chart::SetXAxisLogicalRange	(	double	iXLogicalStart,
		double	iXLogicalEnd
	)

pure virtual

Set logical range of X axis.

Parameters

iXLogicalStart,iXLogicalEnd Specifies the range of X axis.

Implemented in MsiChart::ChartImpl.

◆ ShouldAdjustValueAxis()

virtual bool MsiChart::Chart::ShouldAdjustValueAxis	(	Int32	iWidth,
		Int32	iHeight,
		double &	irAdjustedValue,
		bool	iIsForPefectPadding = `false`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ ShouldRotateDataLabel()

virtual bool MsiChart::Chart::ShouldRotateDataLabel	(	Int32	iWidth,
		Int32	iHeight,
		bool	iIsForPefectPadding = `false`
	)

pure virtual

Implemented in MsiChart::ChartImpl.

◆ VirtualToDevicePoint()

virtual void MsiChart::Chart::VirtualToDevicePoint	(	Int32 &	iorX,
		Int32 &	iorY
	)		const

pure virtual

This function transform a point in virtual coordinate to device coordinate.

Parameters

iorX	Specifies x coordinate of the point.
iorY	Specifies y coordinate of the point.

Implemented in MsiChart::ChartImpl.

Public Member Functions

Member Function Documentation

◆ AddToSelectionList()

◆ AllocSelectionList()

◆ ApplySelectedObjects()

◆ CanShowTooltipById()

◆ cleanDataSet()

◆ ClearOneHighlightObject()

◆ ClearSelectionList()

◆ CreateTooltipByObject() [1/2]

◆ CreateTooltipByObject() [2/2]

◆ CreateToolTipBySeriesAndGroup()

◆ Delete()

◆ DeviceToVirtualPoint()

◆ DisableAnimationForZoom()

◆ DisposeSelectionList()

◆ DrawDataAreaForUniformAxis()

◆ DrawUniformXAxis()

◆ DrawUniformYAxis()

◆ EnableAnimation()

◆ EnableGraphMatrix()

◆ EnableMicroChart()

◆ EnableTimeSeriesChart()

◆ EnableUniformAxis()

◆ EnableVIDocument()

◆ EnableVoiceOver()

◆ EnterDuplicateMode()

◆ EnterGrayoutMode()

◆ ExitDuplicateMode()

◆ ExitGrayoutMode()

◆ GenerateImageMap()

◆ GetAllGraphObjectInfo()

◆ GetAllObjectsWithInDistance()

◆ GetAxisLabelRotaion()

◆ GetAxisNumberFormat()

◆ GetCachedMaxElementSize()

◆ GetCategoryAxisLabelInterval()

◆ GetChartAreaId()

◆ GetData()

◆ GetDataAreaPadding()

◆ GetDataAreaSplitX()

◆ GetDataAreaSplitY()

◆ GetDataGroup()

◆ GetDataPointForUIMenu()

◆ GetGraphHeight()

◆ GetGraphType()

◆ GetGraphWidth()

◆ GetGroupIntervalInPixel()

◆ GetGroupLabel()

◆ GetGroupSpace()

◆ GetHighlightObjects() [1/2]

◆ GetHighlightObjects() [2/2]

◆ GetHoveredLineObject()

◆ GetHoveredObject()

◆ GetInterlacedBandingPosition()

◆ GetIntervalSpace()

◆ GetLastGroupId()

◆ GetMaxElementRadius()

◆ GetMemoryUsageEstimation()

◆ GetNearestObject()

◆ GetNearestObjectForGMCombo()

◆ GetNumOfSelectedObjects()

◆ GetOptions()

◆ GetPieSliceTooltipDataString()

◆ GetPositionAtTick()

◆ GetPositionById()

◆ GetPrimaryDataString()

◆ GetPrimaryDataStringForPie()

◆ GetRowAndColumnIndexByCoords()

◆ GetSeriesColorFromPalette()

◆ GetSeriesLabel()

◆ GetShownNumericTicks()

◆ GetSOByLassoSelection()

◆ GetSpaceAt()

◆ GetStaggerLabelEndLevel()

◆ GetToolTipByCoords() [1/2]

◆ GetToolTipByCoords() [2/2]

◆ GetToolTipData()

◆ GetToolTipDataString() [1/2]

◆ GetToolTipDataString() [2/2]