DataExplorer
Last update: 18.06.2026public class DataExplorer : PHXCOMObject
This is the wrapper class that handles the native COM calls to a Data Explorer. The class is used by Java plug-ins to ModelCenter.
Types
| Name | Summary |
|---|---|
| PHXDEKeepalive | open inner class PHXDEKeepalive : PHXCOMObject |
Functions
| Name | Summary |
|---|---|
| addPage | public addPage(type: String, insertBefore: Long, setupString: String) Adds a page in the DataExplorer --used to be IDispatch in COM |
| addRunsToComparisonList | public addRunsToComparisonList(runIDs: Array<Long>) add a list of runs to the design comparison list |
| addToComparisonList | public addToComparisonList(runID: Long) add a run to the design comparison list |
| disableGC | public disableGC(gc: Boolean) If true, prevents releaseObjects from doing anything. |
| fromXML | public fromXML(xml: String) public fromXML(xml: String, root: String) from XML |
| fromXMLFile | public fromXMLFile(fileName: String) public fromXMLFile(fileName: String, root: String) from XML file |
| getAssociatedModelFile | public getAssociatedModelFile(): String gets the AssociatedModelFile |
| getAssociatedModelFileUUID | public getAssociatedModelFileUUID(): String gets the AssociatedModelFileUUID |
| getAuthor | public getAuthor(): String returns the author |
| getCreationDate | public getCreationDate(): String returns the creation date |
| getDataHistory | public getDataHistory(): DataHistory gets the DataHistory --was IDispatch in COM |
| getDaXFormat | public getDaXFormat(): Boolean |
| getDaXType | public getDaXType(): Boolean check whether the type of data explorer (free/non-free) |
| getDescription | public getDescription(): String gets the description |
| getDisplayName | public getDisplayName(): String gets the Displayname |
| getFileUri | public getFileUri(): String Get the File URI loaded into this DataExplorer. |
| getHWND | public getHWND(): Long |
| getKeepalive | public getKeepalive(): DataExplorer.PHXDEKeepalive Function for internal use only |
| getModelCenter | public getModelCenter(): ModelCenter gets ModelCenter --was IDispatch in COM |
| getNumPages | public getNumPages(): Long returns the number of pages |
| getPageType | public getPageType(page: Long): String gets the page type |
| getSelectedPage | public getSelectedPage(): Long gets the selected page from the DataExplorer |
| getTradeStudySetup | public getTradeStudySetup(): String gets the TradeStudySetup |
| getTradeStudyType | public getTradeStudyType(): String gets the TradeStudyType |
| hide | public hide() |
| ignoreDefaultPlotSetup | public ignoreDefaultPlotSetup(): Boolean check whether the default plot setup should be ignored |
| invokeInsertPageGUI | public invokeInsertPageGUI() Invokes the act of inserting a page in the GUI |
| invokeMenuItem | public invokeMenuItem(item: Long) invokes a given menu item |
| isMenuItemChecked | public isMenuItemChecked(id: Long): Boolean return the check status of Data Explorer menu item (such as tooltip enabled) |
| isMenuItemEnabled | public isMenuItemEnabled(item: Long): Boolean check to see if the menu item is enabled (t/f) |
| isVisible | public isVisible(): Boolean |
| movePage | public movePage(page: Long, insertBefore: Long) moves a page in the DataExplorer |
| multiDelete | public multiDelete(index: String) string of index for deleting pages |
| multiPageCopy | public multiPageCopy(index: String) string of index for copying pages |
| multiPageCut | public multiPageCut(index: String) string of index for cutting pages |
| newInstance | public newInstance(): DataExplorer creates a new DataExplorer object |
| pageCopy | public pageCopy(index: Long) copies a page in the DataExplorer |
| pageCut | public pageCut(index: Long) cuts a page from the DataExplorer |
| pagePaste | public pagePaste() Pastes a page from the DataExplorer |
| release | public release() Releases the COM reference to ModelCenter for this object. |
| releaseObjects | public releaseObjects() This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. |
| removeFromComparisonList | public removeFromComparisonList(runID: Long) remove a run from the design comparison list |
| removePage | public removePage(page: Long) remove a page from the DataExplorer |
| selectPage | public selectPage(page: Long) selects a certain page in the DataExplorer |
| setAssociatedModelFile | public setAssociatedModelFile(filename: String) sets the AssociatedModelFile |
| setAssociatedModelFileUUID | public setAssociatedModelFileUUID(fileUUID: String) sets the AssociatedModelFileUUID |
| setAuthor | public setAuthor(name: String) sets the author |
| setCreationDate | public setCreationDate(creationDate: String) sets the creation date |
| setDescription | public setDescription(desc: String) sets the description |
| setDisplayName | public setDisplayName(name: String) sets the Displayname |
| setFileUri | public setFileUri(fileUri: String) Set the File URI loaded in this DataExplorer. |
| setGeomViewerRunID | public setGeomViewerRunID(viewerID: Long, runID: Long) set runID for the design viewer. |
| setReferenceDebugMode | public setReferenceDebugMode(on: Boolean) When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. |
| setTradeStudySetup | public setTradeStudySetup(tsSetup: String) sets the TradeStudySetup |
| setTradeStudyType | public setTradeStudyType(tsType: String) sets the TradeStudyType |
| setupPlotsPost | public setupPlotsPost() add plots when the trade study finished. |
| setupPlotsPre | public setupPlotsPre() add plots when Data Collector is created. |
| show | public show() |
| showGeomTooltip | public showGeomTooltip(run: Long, xPos: Long, yPos: Long) add plots when the trade study finished. |
| showGeomViewer | public showGeomViewer(run: Long, xPos: Long, yPos: Long) add plots when the trade study finished. |
| toXML | public toXML(): String public toXML(includeRunData: Boolean): String to XML |
| toXMLFile | public toXMLFile(fileName: String) public toXMLFile(fileName: String, includeRunData: Boolean) turns the given file into an XML file |
| updateComparisonViewHint | public updateComparisonViewHint(restore: Boolean) trigger updating the comparison view |
| updateGeomViewerHint | public updateGeomViewerHint(viewerID: Long) trigger updating design viewers. |
| updateThumbHint | public updateThumbHint(item: Long) updates a thumb hint |
