Mobile API Reference  MicroStrategy 2019
RWDDashboardView Class Reference

#import <RWDDashboardView.h>

Inheritance diagram for RWDDashboardView:
<MSIDataViewer>

Instance Methods

(void) - adjustFilterPanelView:
 
(id) - initWithData:dataController:baseURL:webServerType:currentLayoutID:needRender:
 
(void) - startRenderDocument:preview:docName:layout:
 
(void) - magniyGrid:
 
(void) - clearDelegate
 
(void) - generatePreviewImage
 
(RootViewerContainer *) - getRootViewerContainer
 
(void) - resetPositions:
 
(void) - afterBinaryApplied:
 
(void) - hideOrShowSubviews:
 
(void) - setSDKMode
 
(void) - showWaitViewOnExternalDisplay
 
(void) - hideWaitViewOnExternalDisplay
 
(void) - tabSwipeLeft
 
(void) - tabSwipeRight
 
(void) - startAirplay
 
(void) - airplayLayoutLoaded
 
(void) - refreshDockSections
 
(void) - setCustomizedBackgroundColor:
 
(void) - hideTooltipsAfterZooming:
 
(void) - cleanAllViews
 clean all views. By yzhi. More...
 
(void) - finishRenderingProcess
 
(void) - restoreScreen
 
(void) - clickFilterButton
 
(void) - detachFiltersPanelViews
 
(void) - updateFilterPanelView:
 
(void) - broadcastViewerDataModelWillChange
 
(void) - broadcastViewerDataModelDidChange
 
(void) - broadcastViewerDataModelBecomeInvalidated
 
(void) - dismissMagnifyGlassInGridView
 
- Instance Methods inherited from <MSIDataViewer>
(void) - startRenderDocument
 
(void) - updateFrame:
 
(UIView *) - dataView
 
(BOOL- isLandscape
 
(void) - setNeedsDisplay
 
(void) - updateWithData:
 
(void) - viewerWillClose
 
(void) - dataViewWillDisappear
 
(bool) - executeInFullScreenMode
 
(BOOL- showingBarsTemporarily
 
(EnumDSSDisplayMode- getGridDisplayMode
 
(void) - setGridDisplayMode:
 
(BOOL- gridGraphViewerIsFromWidget
 
(void) - afterManipulation:
 
(NSString *) - getClientManipulations
 
(void) - clearClientManipulations
 
(BOOL- replayManipulations:WithData:WithFlags:
 
(BOOL- replayManipulation:WithData:WithFlags:
 
(void) - replayDrillManipulation:WithData:
 
(void) - beginReplayManipulation
 
(void) - endReplayManipulation:
 
(bool) - isDisplayRepromptIcon
 
(void) - updateLayoutInfo:
 
(void) - setLayout:
 
(void) - animateLeft
 
(void) - animateRight
 
(void) - setCachedLayoutID:
 
(void) - enableInteraction:
 
(BOOL- isTransactionEnabled
 
(BOOL- isGeneratePreviewImage
 
(void) - setGeneratePreviewImage:
 
(BOOL- getLayoutKeys:currentLayoutKey:
 
(void) - requestMissingBinary:withHandler:withSelector:
 
(BOOL- isInitialLayoutLoaded
 
(void) - applyLayout:withData:andDataPath:
 
(void) - restoreDetailedTransactionModel:
 
(void) - restoreDetailedTransactionArray:
 
(BOOL- restoreDatasetTransactionModel:andDataArray:
 
(NSArray *) - getDetailedTransactionData
 
(UIView *) - getLayoutIndicator
 
(void) - restoreZoomForBackOperation
 
(int) - getGridGraphViewerPageByStatus
 
(void) - setGridGraphViewerPageByStatus:
 
(BOOL- isDefaultLayoutContainUC
 
(void) - setViewFrame:
 
(void) - setFitWidth:
 
(void) - refresh
 
(void) - setViewOrientation:
 
(void) - replayCarryOverSelections:refreshUI:
 
(UIView *) - getGroupbyView
 
(void) - setGroupbyView:
 
(Commander *) - getCommander
 
(void) - pauseAfterCurrentTask
 
(void) - continueToDoNextTask
 
(BOOL- isChartAvailable
 
(MSIDocumentContext *) - getDocContext
 
(short) - getCurrentLayoutIndex
 
(void) - renderVIDocumentOnExtDisplay
 
(void) - handleTabSelection
 
(void) - changeToControlMode
 
(void) - changeToFilterMode
 
(void) - willBeClosed
 
(BOOL- isVIDocumentRunning
 
(BOOL- isAirplay
 
(BOOL- isVIDocument
 
(BOOL- isAirplayRendered
 
(NSString *) - dashboardName
 
(BOOL- hasTransactionUpdate
 
(NSArray *) - getAllDataSetIDs
 
(NSDictionary *) - getDatasetPromptAnswers
 
(NSInteger) - ReevaluateViewsForUC:
 
(BOOL- stopRenderingProcess
 
(void) - waitRenderingProcess
 
(NSArray *) - getAllLayoutNames
 
(NSArray *) - getAllLayoutKeys
 
(NSString *) - getCurrentLayoutName
 
(NSData *) - getWidgetViewsStatus
 
(int) - replayWidgetViewsStatus:
 
(void) - viewEvaluationFinish
 

Protected Attributes

short mLogLevel
 
void * mpDoc
 
bool bFullScreen
 
BOOL bShowingBarsTemporarily
 
UILabel * mpErrorMessageView
 
RootViewerContainer * mpRootViewer
 
UIView * mpMasterPanel
 
bool isWaitingForUserRuntimeService
 
short mLayoutBarStyle
 
short mLayoutBarPosition
 
bool mEnableZoomByPinchOrDoubleTap
 
UIColor * mpBackgroundColor
 
ExpandablePanelView * expPanelView
 
UIView *__weak groupbyView
 
BOOL fullScreen
 
NSString * mpDashboardName
 
UIScreen * extScreen
 
UIWindow * extWindow
 
UIView * extWindowRootView
 
AnalysisPanelStackViewer * mpDataView
 
UIView * displayInfoMaskView
 
UILabel * displayInfoView
 
bool displayInfoRemoved
 
UIView * blackMaskView
 
UIView * filterView
 
bool isVGAMirroringDisabled
 
bool firstVITabSelection
 
NSArray * tabNames
 
UIAlertController * tabSelectionActionSheet
 
bool isTabSelectionActionSheetShown
 
UILabel * tabNameLabel
 
VIDocumentControlView * controlView
 
VIDocumentTabSwitchView * swipeAreaView
 
HeatMapWidgetViewer * heatMapView
 
MSIMapWidgetViewermapView
 
GraphMatrixWidgetViewer2 * graphMatrixView
 
GridViewer * gridView
 
GraphViewer * graphView
 
int currentTab
 
bool isBuiltInMirroring
 
LaserPointerController * mpLaserPointerController
 
BOOL mIsGeneratePreviewImage
 
RWDataServiceResultresult
 
NSInteger currentLayoutID
 
BOOL mIsInRotation
 
NSMutableDictionary * layoutIDperState
 

Properties

UIView * layoutIndicator
 
MSIDocumentContext * mpDocContext
 
UIView * groupbyView
 
CommandermpCommander
 
BOOL renderFail
 
NSString * dashboardName
 
NSString * reportInfoName
 
DockedSectionContainerheaderSection
 
DockedSectionContainerfooterSection
 
bool isVIDocument
 
bool isVIDocumentRunning
 
int tabNumber
 
bool isAirplay
 
bool isAirplayRendered
 
UIView * activeView
 
BOOL isRWDDashboardViewMovedUp
 
int cannotStopRenderingProcessInstancesCount
 
LayoutManagerController * layoutManagerController
 
bool filtersPanelShown
 
FiltersPanelStackViewer * filterPanelView
 
NSString * templateKey
 

Method Documentation

◆ adjustFilterPanelView:()

- (void) adjustFilterPanelView: (BOOL showFilterButton

◆ afterBinaryApplied:()

- (void) afterBinaryApplied: (BOOL iSuccess

Request missing binary data

Parameters
layoutKeyLayout key to be requested Notify binary has been applied
iSuccessIf the binary applied successfully

Reimplemented from <MSIDataViewer>.

◆ airplayLayoutLoaded()

- (void) airplayLayoutLoaded

◆ broadcastViewerDataModelBecomeInvalidated()

- (void) broadcastViewerDataModelBecomeInvalidated

◆ broadcastViewerDataModelDidChange()

- (void) broadcastViewerDataModelDidChange

◆ broadcastViewerDataModelWillChange()

- (void) broadcastViewerDataModelWillChange

These 2 APIs are used to broadcast view data mode will/did change;

◆ cleanAllViews()

- (void) cleanAllViews

clean all views. By yzhi.

◆ clearDelegate()

- (void) clearDelegate

Reset delegate to avoid accessing released instance

Reimplemented from <MSIDataViewer>.

◆ clickFilterButton()

- (void) clickFilterButton

◆ detachFiltersPanelViews()

- (void) detachFiltersPanelViews

◆ dismissMagnifyGlassInGridView()

- (void) dismissMagnifyGlassInGridView

◆ finishRenderingProcess()

- (void) finishRenderingProcess

◆ generatePreviewImage()

- (void) generatePreviewImage

◆ getRootViewerContainer()

- (RootViewerContainer*) getRootViewerContainer

Return the root viewer container

Returns
The root viewer container

Reimplemented from <MSIDataViewer>.

◆ hideOrShowSubviews:()

- (void) hideOrShowSubviews: (BOOL isHide

◆ hideTooltipsAfterZooming:()

- (void) hideTooltipsAfterZooming: (UIView *)  iView

Hide the tooltips after zooming.

◆ hideWaitViewOnExternalDisplay()

- (void) hideWaitViewOnExternalDisplay

Hide wait indicator

Reimplemented from <MSIDataViewer>.

◆ initWithData:dataController:baseURL:webServerType:currentLayoutID:needRender:()

- (id) initWithData: (void *)  iDocInstance
dataController: (id< RWDDashboardDelegate >)  iDataController
baseURL: (NSString *)  iBaseURL
webServerType: (int)  iWebServerType
currentLayoutID: (int)  iCurrentLayoutID
needRender: (BOOL iNeedRender 

◆ magniyGrid:()

- (void) magniyGrid: (bool)  enabled

◆ refreshDockSections()

- (void) refreshDockSections

◆ resetPositions:()

- (void) resetPositions: (BOOL initial

◆ restoreScreen()

- (void) restoreScreen

Reimplemented from <MSIDataViewer>.

◆ setCustomizedBackgroundColor:()

- (void) setCustomizedBackgroundColor: (UIColor *)  backgroundColor

◆ setSDKMode()

- (void) setSDKMode

◆ showWaitViewOnExternalDisplay()

- (void) showWaitViewOnExternalDisplay

Display wait indicator

Reimplemented from <MSIDataViewer>.

◆ startAirplay()

- (void) startAirplay

◆ startRenderDocument:preview:docName:layout:()

- (void) startRenderDocument: (CGRect)  frame
preview: (NSDictionary *)  images
docName: (NSString *)  docName
layout: (NSInteger)  layoutID 

◆ tabSwipeLeft()

- (void) tabSwipeLeft

◆ tabSwipeRight()

- (void) tabSwipeRight

◆ updateFilterPanelView:()

- (void) updateFilterPanelView: (FiltersPanelStackViewer *)  filter

Member Data Documentation

◆ bFullScreen

- (bool) bFullScreen
protected

◆ blackMaskView

- (UIView*) blackMaskView
protected

◆ bShowingBarsTemporarily

- (BOOL) bShowingBarsTemporarily
protected

◆ controlView

- (VIDocumentControlView*) controlView
protected

◆ currentLayoutID

- (NSInteger) currentLayoutID
protected

◆ currentTab

- (int) currentTab
protected

◆ displayInfoMaskView

- (UIView*) displayInfoMaskView
protected

◆ displayInfoRemoved

- (bool) displayInfoRemoved
protected

◆ displayInfoView

- (UILabel*) displayInfoView
protected

◆ expPanelView

- (ExpandablePanelView*) expPanelView
protected

◆ extScreen

- (UIScreen*) extScreen
protected

◆ extWindow

- (UIWindow*) extWindow
protected

◆ extWindowRootView

- (UIView*) extWindowRootView
protected

◆ filterView

- (UIView*) filterView
protected

◆ firstVITabSelection

- (bool) firstVITabSelection
protected

◆ fullScreen

- (BOOL) fullScreen
protected

◆ graphMatrixView

- (GraphMatrixWidgetViewer2*) graphMatrixView
protected

◆ graphView

- (GraphViewer*) graphView
protected

◆ gridView

- (GridViewer*) gridView
protected

◆ groupbyView

- (UIView* __weak) groupbyView
protected

◆ heatMapView

- (HeatMapWidgetViewer*) heatMapView
protected

◆ isBuiltInMirroring

- (bool) isBuiltInMirroring
protected

◆ isTabSelectionActionSheetShown

- (bool) isTabSelectionActionSheetShown
protected

◆ isVGAMirroringDisabled

- (bool) isVGAMirroringDisabled
protected

◆ isWaitingForUserRuntimeService

- (bool) isWaitingForUserRuntimeService
protected

◆ layoutIDperState

- (NSMutableDictionary*) layoutIDperState
protected

◆ mapView

- (MSIMapWidgetViewer*) mapView
protected

◆ mEnableZoomByPinchOrDoubleTap

- (bool) mEnableZoomByPinchOrDoubleTap
protected

◆ mIsGeneratePreviewImage

- (BOOL) mIsGeneratePreviewImage
protected

◆ mIsInRotation

- (BOOL) mIsInRotation
protected

◆ mLayoutBarPosition

- (short) mLayoutBarPosition
protected

◆ mLayoutBarStyle

- (short) mLayoutBarStyle
protected

◆ mLogLevel

- (short) mLogLevel
protected

◆ mpBackgroundColor

- (UIColor*) mpBackgroundColor
protected

◆ mpDashboardName

- (NSString*) mpDashboardName
protected

◆ mpDataView

- (AnalysisPanelStackViewer*) mpDataView
protected

◆ mpDoc

- (void*) mpDoc
protected

◆ mpErrorMessageView

- (UILabel*) mpErrorMessageView
protected

◆ mpLaserPointerController

- (LaserPointerController*) mpLaserPointerController
protected

◆ mpMasterPanel

- (UIView*) mpMasterPanel
protected

◆ mpRootViewer

- (RootViewerContainer*) mpRootViewer
protected

◆ result

- (RWDataServiceResult*) result
protected

◆ swipeAreaView

- (VIDocumentTabSwitchView*) swipeAreaView
protected

◆ tabNameLabel

- (UILabel*) tabNameLabel
protected

◆ tabNames

- (NSArray*) tabNames
protected

◆ tabSelectionActionSheet

- (UIAlertController*) tabSelectionActionSheet
protected

Property Documentation

◆ activeView

- (UIView *) activeView
readwritenonatomicstrong

◆ cannotStopRenderingProcessInstancesCount

- (int) cannotStopRenderingProcessInstancesCount
readwriteatomicassign

◆ dashboardName

- (NSString*) dashboardName
readwritenonatomiccopy

◆ filterPanelView

- (FiltersPanelStackViewer*) filterPanelView
readwritenonatomicstrong

◆ filtersPanelShown

- (bool) filtersPanelShown
readwritenonatomicassign

◆ footerSection

- (DockedSectionContainer *) footerSection
readwritenonatomicstrong

◆ groupbyView

- (UIView*) groupbyView
readwritenonatomicweak

◆ headerSection

- (DockedSectionContainer *) headerSection
readwritenonatomicstrong

◆ isAirplay

- (bool) isAirplay
readnonatomicassign

◆ isAirplayRendered

- (bool) isAirplayRendered
readnonatomicassign

◆ isRWDDashboardViewMovedUp

- (BOOL) isRWDDashboardViewMovedUp
readwritenonatomicassign

◆ isVIDocument

- (bool) isVIDocument
readnonatomicassign

◆ isVIDocumentRunning

- (bool) isVIDocumentRunning
readnonatomicassign

◆ layoutIndicator

- (UIView *) layoutIndicator
readwritenonatomicstrong

◆ layoutManagerController

- (LayoutManagerController*) layoutManagerController
readwritenonatomicstrong

◆ mpCommander

- (Commander *) mpCommander
readwritenonatomicstrong

◆ mpDocContext

- (MSIDocumentContext *) mpDocContext
readwritenonatomicstrong

◆ renderFail

- (BOOL) renderFail
readnonatomicassign

◆ reportInfoName

- (NSString *) reportInfoName
readwritenonatomiccopy

◆ tabNumber

- (int) tabNumber
readnonatomicassign

◆ templateKey

- (NSString*) templateKey
readwritenonatomiccopy