Mobile API Reference  MicroStrategy 2019
MSIWidgetViewer Class Reference

#import <MSIWidgetViewer.h>

Inheritance diagram for MSIWidgetViewer:
<BinaryRetrievalHandler> <WidgetGridSwitchProtocol> <ItemRendererDelegate> MSIMapWidgetViewer

Instance Methods

(id) - initViewer:withCommanderDelegate:withProps:
 
(id) - initViewer:withCommander:withProps:
 
(void) - setSelfAsDelegateForView:
 
(void) - handleInfoWindowDismissed:
 
(void) - reinit:
 
(void *) - getRWGridIterator
 
(NSString *) - getPrefixForAccLabel:
 
(void) - formatGradientView:
 
(BOOL- canCancelTouches
 
(void) - updateFrame:
 
(void) - dismissTooltips
 
(BOOL- shouldHandleEvent:
 
(void) - updateVisualizationFrame:
 
(NSString *) - getVisualizationTitle
 
(int) - getSelectedObjectsFromPoints:
 
(void) - highlightSelectedElementByLasso
 
(void) - handleMultiSelectionOnTarget
 
(void) - enterMtpMode
 
(void) - exitMtpMode
 
(void) - enterLassoMode
 
(void) - exitLassoMode
 
(BOOL- supportDrill
 
(BOOL- targetDefineForVIWidget
 
(void) - setupCanvasViewInLasso:
 
(void) - setCanvasViewAnnotationShape:
 
(void) - showActionArrowButton:
 
(void) - updateMultipleDoneButtonIfNeeded
 
(void) - countSelectedByLasso
 
(void) - dismissTooltipsAndItsHighlighting
 
(void) - drillForLassoSelection2
 
(BOOL- hasDropZoneInfo
 
(NSMutableArray *) - getIndexArrayFromDropZoneByType:needsTemplateMetric:on:
 
(UIView *) - touchesHandlerView
 
(void) - cancelSingleTapGestureOnVICanvasView
 
(BOOL- supportKeepOnlyAndShow
 
(UIView *) - getVITitleBar
 
(UIView *) - getContainerView
 
(NSArray *) - getSelectedCoordinatesDrill
 
(void) - releaseDataModelMemory
 
(BOOL- emptyDataSetHandling
 
(BOOL- emptyDataSetHandlingForCalendar
 
(void) - hideWaitView
 
(void) - showWaitView
 
(void) - decreaseWidgetCount
 
(UIView *) - getRootView
 
(UIView *) - rootViewer
 
(void) - createWidgetOnLayoutOrPanelChange
 
(void) - cleanWidgetOnLayoutOrPanelChange
 
(void) - adjustFrameSize
 
(void) - onViewReload:
 
(CGRect) - getFrameWithSafeArea:
 
(void) - showAfterRotation
 
(void) - hideAfterRotation
 
(void) - saveStateBeforeRotate
 
(void) - unsaveStateForRotate
 
(void) - updateAfterRotate
 
(void) - saveWidgetViewerState
 
(void) - restoreWidgetViewerState
 
(void) - setUpTaskQueue
 
(BOOL- dispatchTask
 
(BOOL- submitTask:
 
(void) - appendToTaskQueue:
 
(void) - cleanTaskQueue
 
(void) - pauseTask
 
(void) - resumeTask
 
(void) - callbackTasks
 
(void) - destroyTaskQueue
 
(void) - callbackTasksAndReleasePara
 
- Instance Methods inherited from <ItemRendererDelegate>
(void) - handleCEChartItemDoubleTouch:
 
(void) - handleCEChartItemSingleTouch:
 
(void) - handleCEChartAvgDataRecord:withCount:withSeriesID:
 
(void) - handleTooltipRelease:
 
(void) - handleTextSingleTouch:
 
(void) - handleTextDoubleTouch:
 
(void) - handlePivotTextTouchesBegan:
 
(void) - handlePivotTextTouchesMoved:withPoint:
 
(void) - handlePivotTextTouchesEnded:
 
- Instance Methods inherited from <WidgetGridSwitchProtocol>
(void) - quickSwitchToGrid
 
(void) - quickSwitchToWidget
 
(void) - cleanViews
 
(void) - recreateWidget
 
(BOOL- finishedFirstRendering
 
(void) - requestSecondaryDataModel:
 
- Instance Methods inherited from <BinaryRetrievalHandler>
(void) - OnRetrievalFinished:withSelector:
 

Class Methods

(UINavigationController *) + getNavigationController
 

Protected Attributes

MSIWidgetHelperwidgetHelper
 
ThemeType mThemeType
 
GridGraphViewer * mpGridGraphViewer
 
NSMutableArray * mTaskQueue
 
bool mIsChartAvailable
 
BOOL mIsLayoutOrPanelChanged
 
BOOL mIsInValidTemplate
 
BOOL mbInWidgetMode
 
NSString * mAccessibilityLabel
 
UILabel * mErrorLabel
 
WidgetPropertiesStore * mPropertiesStore
 
BOOL mStateSaved
 
BOOL mbDataModelChallenged
 
WaitView * mpWaitView
 
ViewerDataModelviewerDataModel
 
BOOL mIsMtpMode
 
BOOL mIsLassoMode
 
UIView * mTemporyCanvasView
 
ActionMenuForLassoSelection * mActionMenu
 
CGSize mWidgetSizeForLastActionMenu
 
BOOL mIsVIDocument
 
UIView * mpDrillView
 
NSString * mDrillLabel
 
NSInteger mSelectedNumLasso
 
NSData * mRestoreData
 

Properties

NSString * drillLabel
 
BOOL isVIDocument
 
UIView * lassoCanvasView
 
BOOL isMtpMode
 
BOOL isLassoMode
 
UILabel * errorLabel
 
MSIReportDisplayInfodocument
 
id< MSICommanderDelegate > commanderDelegate
 
BOOL ignoreReleaseDataModelMemory
 
BOOL delayReleaseDataModelMemory
 

Method Documentation

◆ adjustFrameSize()

- (void) adjustFrameSize

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ appendToTaskQueue:()

- (void) appendToTaskQueue: (Task *)  iTask

Provided by category MSIWidgetViewer(Tasks).

◆ callbackTasks()

- (void) callbackTasks

Provided by category MSIWidgetViewer(Tasks).

◆ callbackTasksAndReleasePara()

- (void) callbackTasksAndReleasePara

Provided by category MSIWidgetViewer(Tasks).

◆ canCancelTouches()

- (BOOL) canCancelTouches

◆ cancelSingleTapGestureOnVICanvasView()

- (void) cancelSingleTapGestureOnVICanvasView

◆ cleanTaskQueue()

- (void) cleanTaskQueue

Provided by category MSIWidgetViewer(Tasks).

◆ cleanWidgetOnLayoutOrPanelChange()

- (void) cleanWidgetOnLayoutOrPanelChange

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ countSelectedByLasso()

- (void) countSelectedByLasso

◆ createWidgetOnLayoutOrPanelChange()

- (void) createWidgetOnLayoutOrPanelChange

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ decreaseWidgetCount()

- (void) decreaseWidgetCount

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ destroyTaskQueue()

- (void) destroyTaskQueue

Provided by category MSIWidgetViewer(Tasks).

◆ dismissTooltips()

- (void) dismissTooltips

◆ dismissTooltipsAndItsHighlighting()

- (void) dismissTooltipsAndItsHighlighting

◆ dispatchTask()

- (BOOL) dispatchTask

Provided by category MSIWidgetViewer(Tasks).

◆ drillForLassoSelection2()

- (void) drillForLassoSelection2

◆ emptyDataSetHandling()

- (BOOL) emptyDataSetHandling

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ emptyDataSetHandlingForCalendar()

- (BOOL) emptyDataSetHandlingForCalendar

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ enterLassoMode()

- (void) enterLassoMode

◆ enterMtpMode()

- (void) enterMtpMode

◆ exitLassoMode()

- (void) exitLassoMode

◆ exitMtpMode()

- (void) exitMtpMode

◆ formatGradientView:()

- (void) formatGradientView: (GradientViewer *)  gradientViewer

◆ getContainerView()

- (UIView*) getContainerView

◆ getFrameWithSafeArea:()

- (CGRect) getFrameWithSafeArea: (CGRect)  frame

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ getIndexArrayFromDropZoneByType:needsTemplateMetric:on:()

- (NSMutableArray*) getIndexArrayFromDropZoneByType: (int)  dropZoneUnitType
needsTemplateMetric: (BOOL needsTemplateMetric
on: (EnumDSSAxisName axis 

◆ getNavigationController()

+ (UINavigationController*) getNavigationController

◆ getPrefixForAccLabel:()

- (NSString*) getPrefixForAccLabel: (UIView *)  renderer

◆ getRootView()

- (UIView*) getRootView

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ getRWGridIterator()

- (void*) getRWGridIterator

◆ getSelectedCoordinatesDrill()

- (NSArray*) getSelectedCoordinatesDrill

◆ getSelectedObjectsFromPoints:()

- (int) getSelectedObjectsFromPoints: (NSArray *)  iPointArray

◆ getVisualizationTitle()

- (NSString*) getVisualizationTitle

◆ getVITitleBar()

- (UIView*) getVITitleBar

◆ handleInfoWindowDismissed:()

- (void) handleInfoWindowDismissed: (NSObject *)  lpObj

◆ handleMultiSelectionOnTarget()

- (void) handleMultiSelectionOnTarget

◆ hasDropZoneInfo()

- (BOOL) hasDropZoneInfo

◆ hideAfterRotation()

- (void) hideAfterRotation

Provided by category MSIWidgetViewer(Rotation).

◆ hideWaitView()

- (void) hideWaitView

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ highlightSelectedElementByLasso()

- (void) highlightSelectedElementByLasso

◆ initViewer:withCommander:withProps:()

- (id) initViewer: (ViewerDataModel *)  _viewerDataModel
withCommander: (Commander *)  _commander
withProps: (NSString *)  _props 

◆ initViewer:withCommanderDelegate:withProps:()

- (id) initViewer: (ViewerDataModel *)  _viewerDataModel
withCommanderDelegate: (id< MSICommanderDelegate >)  _commander
withProps: (NSString *)  _props 

◆ onViewReload:()

- (void) onViewReload: (NSNotification *)  sender

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ pauseTask()

- (void) pauseTask

Provided by category MSIWidgetViewer(Tasks).

◆ reinit:()

- (void) reinit: (ViewerDataModel *)  _viewerDataModel

◆ releaseDataModelMemory()

- (void) releaseDataModelMemory

◆ restoreWidgetViewerState()

- (void) restoreWidgetViewerState

Provided by category MSIWidgetViewer(Rotation).

◆ resumeTask()

- (void) resumeTask

Provided by category MSIWidgetViewer(Tasks).

◆ rootViewer()

- (UIView*) rootViewer

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ saveStateBeforeRotate()

- (void) saveStateBeforeRotate

Provided by category MSIWidgetViewer(Rotation).

◆ saveWidgetViewerState()

- (void) saveWidgetViewerState

Provided by category MSIWidgetViewer(Rotation).

◆ setCanvasViewAnnotationShape:()

- (void) setCanvasViewAnnotationShape: (AnnotationShape shapeType

◆ setSelfAsDelegateForView:()

- (void) setSelfAsDelegateForView: (UIView *)  ipView

◆ setupCanvasViewInLasso:()

- (void) setupCanvasViewInLasso: (BOOL isLasso

◆ setUpTaskQueue()

- (void) setUpTaskQueue

Provided by category MSIWidgetViewer(Tasks).

◆ shouldHandleEvent:()

- (BOOL) shouldHandleEvent: (NSString *)  ipEventName

◆ showActionArrowButton:()

- (void) showActionArrowButton: (BOOL show

◆ showAfterRotation()

- (void) showAfterRotation

Provided by category MSIWidgetViewer(Rotation).

◆ showWaitView()

- (void) showWaitView

Provided by category MSIWidgetViewer(ProtectedMethod).

◆ submitTask:()

- (BOOL) submitTask: (Task *)  iTask

Provided by category MSIWidgetViewer(Tasks).

◆ supportDrill()

- (BOOL) supportDrill

◆ supportKeepOnlyAndShow()

- (BOOL) supportKeepOnlyAndShow

◆ targetDefineForVIWidget()

- (BOOL) targetDefineForVIWidget

◆ touchesHandlerView()

- (UIView*) touchesHandlerView

◆ unsaveStateForRotate()

- (void) unsaveStateForRotate

Provided by category MSIWidgetViewer(Rotation).

◆ updateAfterRotate()

- (void) updateAfterRotate

Provided by category MSIWidgetViewer(Rotation).

◆ updateFrame:()

- (void) updateFrame: (CGRect)  frame

◆ updateMultipleDoneButtonIfNeeded()

- (void) updateMultipleDoneButtonIfNeeded

◆ updateVisualizationFrame:()

- (void) updateVisualizationFrame: (CGRect)  iFrame

Member Data Documentation

◆ mAccessibilityLabel

- (NSString *) mAccessibilityLabel
readwritenonatomicstrongprotected

◆ mActionMenu

- (ActionMenuForLassoSelection*) mActionMenu
protected

◆ mbDataModelChallenged

- (BOOL) mbDataModelChallenged
protected

◆ mbInWidgetMode

- (BOOL) mbInWidgetMode
protected

◆ mDrillLabel

- (NSString*) mDrillLabel
protected

◆ mErrorLabel

- (UILabel*) mErrorLabel
protected

◆ mIsChartAvailable

- (bool) mIsChartAvailable
readwritenonatomicassignprotected

◆ mIsInValidTemplate

- (BOOL) mIsInValidTemplate
protected

◆ mIsLassoMode

- (BOOL) mIsLassoMode
protected

◆ mIsLayoutOrPanelChanged

- (BOOL) mIsLayoutOrPanelChanged
protected

◆ mIsMtpMode

- (BOOL) mIsMtpMode
protected

◆ mIsVIDocument

- (BOOL) mIsVIDocument
protected

◆ mpDrillView

- (UIView*) mpDrillView
protected

◆ mpGridGraphViewer

- (GridGraphViewer*) mpGridGraphViewer
protected

◆ mPropertiesStore

- (WidgetPropertiesStore *) mPropertiesStore
readwritenonatomicstrongprotected

◆ mpWaitView

- (WaitView*) mpWaitView
protected

◆ mRestoreData

- (NSData*) mRestoreData
protected

◆ mSelectedNumLasso

- (NSInteger) mSelectedNumLasso
readwritenonatomicassignprotected

◆ mStateSaved

- (BOOL) mStateSaved
protected

◆ mTaskQueue

- (NSMutableArray*) mTaskQueue
protected

◆ mTemporyCanvasView

- (UIView*) mTemporyCanvasView
protected

◆ mThemeType

- (ThemeType) mThemeType
protected

◆ mWidgetSizeForLastActionMenu

- (CGSize) mWidgetSizeForLastActionMenu
protected

◆ viewerDataModel

- (ViewerDataModel *) viewerDataModel
readwritenonatomicstrongprotected

◆ widgetHelper

- (MSIWidgetHelper *) widgetHelper
readwritenonatomicstrongprotected

Property Documentation

◆ commanderDelegate

- (id<MSICommanderDelegate>) commanderDelegate
readwritenonatomicweak

◆ delayReleaseDataModelMemory

- (BOOL) delayReleaseDataModelMemory
readwritenonatomicassign

◆ document

- (MSIReportDisplayInfo*) document
readnonatomicweak

◆ drillLabel

- (NSString*) drillLabel
readwritenonatomicstrong

◆ errorLabel

- (UILabel*) errorLabel
readwritenonatomicstrong

◆ ignoreReleaseDataModelMemory

- (BOOL) ignoreReleaseDataModelMemory
readwritenonatomicassign

◆ isLassoMode

- (BOOL) isLassoMode
readwritenonatomicassign

◆ isMtpMode

- (BOOL) isMtpMode
readwritenonatomicassign

◆ isVIDocument

- (BOOL) isVIDocument
readnonatomicassign

◆ lassoCanvasView

- (UIView*) lassoCanvasView
readwritenonatomicstrong