Mobile API Reference
MicroStrategy 2019
|
#import <Commander.h>
- (void) afterBinaryApplied: | (BOOL) | iSuccess |
- (void) afterManipulation: | (NSValue *) | iValue |
- (void) beginReplayManipulation |
- (CarryOverSelectionsSet*) carryOverSelections |
- (CarryOverSelectionsSet*) carryOverSelectionsWithMode: | (CarryOverSelectedMode) | mode | |
withPromptMode: | (BOOL) | promptMode | |
currentPrompt: | (NSString *) | currentPrompt | |
- (BOOL) checkForTransactionUpdate |
- (UIView *) checkIfInDockedSection: | (UIView *) | view |
- (NSInteger) chooseDocumentViewForInterfaceOrientation: | (UIInterfaceOrientation) | interfaceOrientation |
- (void) clearClientManipulations |
- (void) clearNGBSelectionsAllFields |
Clear NGB setting inside Commander.
- (void) createNewFolder: | (NSString *) | parentFolderID | |
andFolderName: | (NSString *) | folderName | |
andFolderDesc: | (NSString *) | folderDescription | |
Provided by category Commander(MOBILE_VI).
- (void) dataModelCreationFailed |
- (void) decreaseWidgetCount: | (id) | viewer |
- (void) disableIPhoneLayoutBar: | (BOOL) | disable |
- (void) dismissWaitViewOnTop |
- (NSString*) documentName |
- (DocumentThemeHelper*) documentThemeHelperWithComponentKey: | (NSString *) | componnetKey |
- (void) enableInteraction: | (BOOL) | enabled |
- (void) endReplayManipulation: | (BOOL) | needRefresh |
- (int) executeCommands: | (const std::vector< Command * > &) | iCommands |
- (int) executeCommands: | (const std::vector< Command * > &) | iCommands | |
asyncExec: | (BOOL) | async | |
- (int) executeCommands: | (const std::vector< Command * > &) | iCommands | |
ShowWaitView: | (BOOL) | showWaitView | |
- (int) executeCommands: | (const std::vector< Command * > &) | iCommands | |
showWaitViewOnView: | (UIView *) | view | |
- (void) executeCommitTransactionWithTargetKeys: | (NSArray *) | targetKeys |
- (void) executeLinkDrill: | (LinkDrillParameters *) | linkDrillParams |
- (void) findAllPanelStackTargets: | (DSSRWControl *) | ipRWControl | |
withOutputs: | (std::vector< DSSRWSectionNode * > &) | vTargetNodes | |
Find all the panel stack targets for a given control node. Added by yzhi If there are nested panel stacks, all the panel stack nodes nested inside are returned.
ipRWControl | a control node |
vTargetNodes | array of target panel stack nodes |
- (void) findFirstPanelStackTargets: | (DSSRWControl *) | ipRWControl | |
withOutputs: | (std::vector< DSSRWSectionNode * > &) | vTargetNodes | |
Find the first panel stack targets for a given control node. Added by njiang If there are nested panel stacks, all the panel stack nodes nested inside are returned.
ipRWControl | a control node |
vTargetNodes | array of target panel stack nodes |
- (void) generatePreviewImage |
- (NSArray*) getAllDataSetIDs |
- (NSArray *) getAllLayoutKeys |
- (NSArray *) getAllLayoutNames |
- (vector<void*>) Commander: | (void *) | iCellHandle |
- (CGFloat) getCalGroupbyHeight |
- (NSString*) getClientManipulations |
- (NSInteger) getColorByItemIndexByColorByString: | (NSString *) | colorByItemString |
- (void*) getCommandByType: | (int) | iType |
- (NSString*) getCurrentLayoutKey |
This method can get current layout even it is not a VI document, and an exception is pre-orion document.
- (NSString*) getCurrentLayoutName |
- (void) getCurrentPageIndex: | (int &) | iCurrentPageIndex | |
totalPageCount: | (int &) | iTotalPagesCount | |
Calculate the current page index.
- (NSString*) getCurrentVisualizationContentPanelStackKey |
Get the visualziationContentPanelStackKey for current layout. This panelstack is the root of visualization zone (and page-by zone, according to lcao). Use [NSString cStringUsingEncoding:] if you need c string or std::string.
- (NSDictionary*) getDatasetPromptAnswers |
- (NSArray*) getDetailedTransactionData |
- (int) getDisplayMode |
- (MSIDocumentContext *) getDocContext |
- (DSSDocumentInstance*) getDocInstance |
- (double) getDockedFooterHeight |
- (double) getDockedHeaderHeight |
- (DSSRWIterator*) getDSSRWIteratorForTransactionReport: | (NSString *) | transactionReportID |
Returns DSSRWIterator
mapped to transactionReport
transactionReportID | transaction report's ID |
- (void) getEmptyGridDisplay: | (NSString **) | emptyMessage | |
display: | (BOOL *) | displayEmptyMsg | |
- (GridGraphViewer*) getGridGraphViewerForReport |
- (CGFloat) getHeaderSectionYOffset |
- (void) getImagesFromIServer: | (NSArray *) | iImagesArray | |
forTimeStamp: | (NSArray *) | iImagesTimeStamp | |
forAsync: | (BOOL) | ibAsync | |
- (DSSCMacroManipulation *) getMacroManipulationWithResetToFirstPanelCommand: | (const std::string &) | irSelectorKey |
Generate a MacroManipulation with ResetToFirstPanel command added, if any.
irSelectorKey | the node key of the selector whose target is a panel stack. |
- (MapNameToNodeKey*) getMapNameToNodeKey |
- (MapNodeKeyToMasterViewers*) getMapNodeKeyToMasterViewers |
- (MapNodeKeyToViewers*) getMapNodeKeyToViewers |
- (int) getNGBFirstRowIndexInCurrentPage |
Get the first row indiex in the current page.
- (NSUInteger) getNumberOfDocumentViews |
Get the number of document views. 03/07, 2013 yzeng add.
- (NSArray*) getPaletteColors |
- (vector<DSSRWSectionNode*>) Commander: | (MSIURLHelper *) | iUrlHelper |
- (DSSBaseElementProxy*) getReplacedElement: | (std::string) | iNodeKey |
- (CATransform3D) getRescaleTransformForIPhone6: | (CGFloat) | originHeight | |
isLandscape: | (BOOL) | isLandscape | |
isFullscreenDoc: | (BOOL) | isFullscreen | |
extraOccupiedHeight: | (CGFloat) | extraOccupiedHeight | |
Get the transform for auto fitting iPhone 5 view for iPhone 6/6+ aspect-ratio devices, TQMS 977109
originHeight | the oritianl height of content |
isLandscape | whether the device is landscape |
isFullscreen | if YES, we should consider that the navigation bar is not existing |
extraOccupiedHeight | we may need to consider the height occupied by other things like the groupby bar |
- (UIView*) getRootViewContainer |
- (UIView*) getRWDDashBoardView |
- (NSData*) getSavedViewerStatus: | (NSString *) | iViewerID |
Get the specific Viewer's status data, whose ID = iViewerID.
- (NSString*) getSelectedElementOfAttribute: | (NSString *) | attributeId |
- (NSArray*) getViewerChangedListAfterManipulation |
This function will return the change list, the content is a list of UIView
- (NSData*) getViewersStatus |
Collect all the views status that response to [IViewer getViewerStatus].
- (NSString*) getVisualizationContentPanelStackKeyForLayout: | (NSString *) | iLayoutKey |
Get the visualziationContentPanelStackKey for given layout.
- (BOOL) goToNextPage |
Change NGB page to the next one. Called in [LayoutContainerViewer - (void)handleEvent].
- (BOOL) goToPreviousPage |
Change NGB page to the previous one. Called in [LayoutContainerViewer - (void)handleEvent].
- (void) handleActionSheet: | (MSIURLHelper *) | urlHelper |
- (void) handleBrushingHighlightForVI: | (BrushingHighlightData *) | highlightData |
This method helps handling brushing highlight event in vi documents
Provided by category Commander(MOBILE_VI).
- (void) handleEPUB: | (MSIURLHelper *) | _urlHelper |
- (void) handleEPUB: | (MSIURLHelper *) | _urlHelper | |
withSender: | (UIView *) | iView | |
- (void) handleLinkDrill: | (MSIURLHelper *) | urlHelper |
- (void) handleLinkDrill: | (MSIURLHelper *) | urlHelper | |
withContext: | (PopoverContext *) | iContext | |
- (void) handlePDF: | (MSIURLHelper *) | urlHelper |
- (void) handleRenderFinishTime: | (NSDate *) | date |
- (void) handleURLSelection: | (MSIURLHelper *) | iUrlHelper |
- (void) handleWillQuitExport: | (void(^)()) | handler |
- (BOOL) hasNavigationTabBar |
- (BOOL) hasNextPage |
Used to judge whether have next page for NGB section.
- (BOOL) hasPreviousPage |
Used to judge whether have previous page for NGB section.
- (void) hideAllInfoWindows: | (BOOL) | animated |
- (void) hideMasterPanel: | (BOOL) | disable |
- (void) hideRightNavigationBarButtons |
- (void) increaseWidgetCount: | (id) | viewer |
- (void) initNGBSelections: | (DSSRWSectionIterator *) | ipIterator |
Used to init NGB setting. It is called in DocumentIterator.
- (BOOL) isDisabledforShowPrompt |
- (BOOL) isDockedPanelStackSelector: | (NodeAndControls *) | lControl |
Check whether the panel stack selector is docked. Imported from PanelStackViewer. Added by yzhi.
lControl | a given control node |
- (BOOL) isDuringBackward |
- (BOOL) isExporting |
- (BOOL) isFullScreen |
- (BOOL) isMultiSelectionMode |
- (BOOL) isViewerDocked: | (UIView *) | view |
- (id) loadWidgetState: | (id) | key |
- (id) loadWidgetStateForKey: | (id) | key |
- (BOOL) needReInitNGBSelections |
Used to judge whether NGB need to reinit, e.g., change sub NGB, it need to reinit NGB setting.
- (void) notifyPanelStackResetToFirstPanel: | (const std::string &) | selectorKey |
notify the panel stack(s) targeted by a given selector to reset to first panel. Added by yzhi. Usually use NSNotification (observer pattern) to notify the panel stack viewers. However, if the panel stack viewer does not exist, DSSCManipulationSetCurrentPanel in commander will be executed.
selectorKey | the node key of selector |
- (void) photoUploadImageChange: | (NSString *) | ipNodeKey | |
imgPath: | (NSString *) | ipImgPath | |
- (void) photoUploadImageChange: | (NSString *) | ipNodeKey | |
imgPath: | (NSString *) | ipImgPath | |
shouldReplacePreImage: | (BOOL) | replace | |
- (void) photoUploadImageChange: | (const std::vector< Command * > &) | iCommands | |
nodeKey: | (NSString *) | ipNodeKey | |
imgPath: | (NSString *) | ipImgPath | |
- (void) photoUploadImageChange: | (const std::vector< Command * > &) | iCommands | |
nodeKey: | (NSString *) | ipNodeKey | |
imgPath: | (NSString *) | ipImgPath | |
shouldReplacePreImage: | (BOOL) | replace | |
- (void) refreshInstanceWithData: | (NSData *) | newData |
- (void) registerMasterView: | (id< IViewer >) | iViewer | |
forNodeKey: | (std::string) | iNodeKey | |
- (void) registerViewer: | (id< IViewer >) | iViewer | |
forNodeKey: | (std::string) | iNodeKey | |
- (void) reinitNGBSelections |
Reinit NGB setting inside Commander.
- (void) removeVisualizationContentPanelStackKeyForLayout: | (NSString *) | iLayoutKey |
Remove the visualziationContentPanelStackKey for given layout.
- (id) replayCarryOverPrompts: | (CarryOverSelectionsSet *) | selections | |
withPromptQuestionXML: | (NSData *) | promptQestion | |
withPrompts: | (id) | data | |
replay manipulations in the carry over selection
selections | carry over selections set |
refresh | Is it necessary to refresh the UI after replay action |
- (void) replayDrillManipulation: | (DrillXMLCommandParameters *) | parameters | |
WithData: | (NSData *) | newData | |
- (BOOL) replayManipulation: | (NSString *) | events | |
WithData: | (NSData *) | newData | |
WithFlags: | (unsigned int) | flags | |
- (BOOL) replayManipulations: | (NSArray *) | events | |
WithData: | (NSData *) | newData | |
WithFlags: | (unsigned int) | flags | |
- (int) replayViewersStatus: | (NSData *) | iData |
Restore all the views data stored as before.
- (BOOL) requestLayoutData: | (DSSRWNode *) | iRWNode | |
withHandler: | (id< BinaryRetrievalHandler >) | iHandler | |
withSelector: | (SEL) | callbackFunction | |
- (void) requestMissingBinaryBlock: | (NSString *) | iLayoutKey |
- (void) restoreDetailedTransactionArray: | (NSArray *) | iTransactionDetails |
- (void) restoreDetailedTransactionModel: | (TransactionParameters *) | iTransactionParameters |
- (void) restoreZoomForBackOperation |
- (void) saveAsVIDocument: | (NSString *) | folderID | |
andDocName: | (NSString *) | docName | |
andDocDesc: | (NSString *) | docDescription | |
andSFlag: | (EnumDSSXMLDocSaveAsFlags) | flag | |
Provided by category Commander(MOBILE_VI).
- (void) saveWidgetState: | (id) | obj | |
forKey: | (id) | key | |
- (void) saveWidgetStateWithObject: | (id) | obj | |
forKey: | (id) | key | |
- (void) setContentScaleFactorOnDemandToViews: | (UIView *) | iView | |
rootView: | (UIView *) | iRootView | |
- (void) setContentScaleFactorOnDemandToViews: | (UIView *) | iView | |
rootView: | (UIView *) | iRootView | |
informView: | (BOOL) | inform | |
- (void) setDisplayMode: | (int) | iDispalyMode |
- (void) setDocContext: | (MSIDocumentContext *) | iDocContext |
- (void) setDocInstance: | (DSSDocumentInstance *) | instance |
- (void) setRootViewContainer: | (UIView *) | iRootViewContainer |
- (void) setRWDDashBoardView: | (UIView *) | RWDDashBoardView |
- (void) setSavedPopoverContext: | (PopoverContext *) | iContext |
- (void) setVisualizationContentPanelStackKey: | (NSString *) | iVIContentPanelStackKey | |
forLayout: | (NSString *) | iLayoutKey | |
Set the visualziationContentPanelStackKey for given layout.
- (BOOL) shouldCancelRendering |
- (bool) shouldDismissIW: | (InfoWindowContainerViewer *) | infoWindow | |
withURLHelper: | (MSIURLHelper *) | urlHelper | |
- (void) showMasterPanel |
- (void) showRightNavigationBarButtons |
- (void) showWaitViewOnTop |
- (BOOL) SynchWithSelectorFromPanelStack: | (DSSRWSectionNode *) | ipRWSectionNode | |
withIndex: | (const int) | iIdx | |
Synchronize selector(s) with panel stack by a given index. Imported from PanelStackViewer. Added by yzhi.
ipRWSectionNode | panel stack node |
iIdx | the panel index to synchronize |
- (void) unregisterMasterViewer: | (id< IViewer >) | iViewer |
- (void) unregisterViewer: | (id< IViewer >) | iViewer |
- (void) unregisterViewersWithNodeKey: | (std::string) | iNodeKey |
- (void) updateNGBSelectionAfterRotation |
Update the NGB setting inside commander. Called in [LayoutContainerViewer - (void)handleEvent].
- (void) updatePreviewImages: | (NSDictionary *) | images |
- (CGRect) updateRootViewerContainerFrame: | (CGRect) | frame |
- (BOOL) validateCacheExecuteLinkDrill: | (LinkDrillParameters *) | linkDrillParams |
- (BOOL) validateCacheHandleLinkDrill: | (MSIURLHelper *) | urlHelper |
- (void) viewEvaluationFinish |
- (void) zoomDashboardToScale: | (CGFloat) | iScale |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
readwritenonatomicassign |
|
readnonatomicassign |
|
readwritenonatomiccopy |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |
|
readwritenonatomicweak |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |
|
readwritenonatomicstrong |
|
readwritenonatomicweak |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwriteatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readnonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |
|
readwritenonatomicassign |
|
readnonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readnonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |
|
readwritenonatomicweak |
|
readwritenonatomicweak |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |
|
readwritenonatomicassign |
|
readwritenonatomicweak |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicweak |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicassign |
|
readwritenonatomicstrong |