Interface PHXDATAEXPLORERLib::\_DPHXDataExplorer

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 35)

The Data Explorer object represents a Data Explorer window, the enclosed Data History, all the pages, and associated meta-data. This API supercedes the Data Collector API (which still works for backwards compatibility).

Members

• addPage
• addRunsToComparisonList
• addToComparisonList
• associatedModelFile
• associatedModelFileUUID
• author
• creationDate
• description
• displayName
• ensureRunDataAction
• exportImage
• fromCenterLink
• fromXML
• fromXMLFile
• fromXMLSaveContext
• getDaXFormat
• getDaXType
• getHWND
• getKeepalive
• getMenuItems
• getNumPages
• getPage
• getPageSetup
• getPageTitle
• getPageType
• getSelectedPage
• hide
• id
• id
• ignoreDefaultPlotSetup
• invokeInsertPageGUI
• invokeMenuItem
• isMenuItemChecked
• isMenuItemEnabled
• isVisible
• loadTemplate
• movePage
• multiDelete
• multiPageCopy
• multiPageCut
• pageCopy
• pageCut
• pagePaste
• removeFromComparisonList
• removePage
• saveTemplate
• selectPage
• setGeomViewerRunID
• setupPlotsPost
• setupPlotsPre
• show
• showGeomTooltip
• showGeomViewer
• toXML
• toXMLFile
• toXMLSaveContext
• tradeStudyUri
• updateComparisonViewHint
• updateGeomViewerHint
• updateThumbHint

Properties

Property author

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::author

The author of the data in this Data Explorer.

Return type: BSTR

Property description

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::description

A description of the data in this Data Explorer.

Return type: BSTR

Property displayName

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::displayName

A display name for this Data Explorer.

Return type: BSTR

Property id

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 66)

tradeStudyType PHXDATAEXPLORERLib::_DPHXDataExplorer::id

A pointer to the associated ModelCenter session. Points to a ModelCenter.Application or ModelCenter.IModelCenter object.

Return type: tradeStudyType

Property id

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 74)

tradeStudySetup PHXDATAEXPLORERLib::_DPHXDataExplorer::id

A pointer to the included Data History object.

Return type: tradeStudySetup

Property associatedModelFile

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFile

The filename of the associated model file for this Data Explorer.

Return type: BSTR

Property associatedModelFileUUID

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFileUUID

The UUID of the associated Model.

Return type: BSTR

Property creationDate

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::creationDate

The creation date of the model.

Return type: BSTR

Property tradeStudyUri

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 1)

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::tradeStudyUri

The URI of the file loaded in this object, empty for no currently loaded file. Changing this does not load a new file, it is merely a container for a string.

Return type: BSTR

Property isVisible

Definition: LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl (line 347)

PHXDATAEXPLORERLib::_DPHXDataExplorer::isVisible

Is the window visible?

Return type:

Public functions

Function getNumPages

long PHXDATAEXPLORERLib::_DPHXDataExplorer::getNumPages()

Gets the number of pages in this Data Explorer. Returns:

The number of pages.

Return type: long

Function getPage

IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getPage(long page)

Get an IDispatch for the requested page.

Parameters:

• page: The 0 based index to the requested page.

Returns:

An IDispatch for the requested page. This pointer is guaranteed to implement PHXDataExplorerPlugIn and may additionally implement other interfaces.

Parameters:

• long page

Return type: IDispatch *

Function addPage

IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::addPage(BSTR type, VARIANT insertBefore, VARIANT setupString)

Adds a new page to the Data Explorer.

Parameters:

• type: Select the type of page to create. May be a COM Application ID (such as PHXCarpetPlot.Application) or a name as registered with ModelCenter's PlugIn Manager's Data Explorer Plug-Ins section (such as "Carpet Plot").
• insertBefore: Where to insert the page. May be -1 or omitted to place at the end.
• setupString: An optional string to pass to the newly created page's fromString() call. Format is page dependent.

Returns:

The IDispatch of the newly created page. This pointer is guaranteed to implement PHXDataExplorerPlugIn and may additionally implement other interfaces.

Parameters:

• BSTR type
• VARIANT insertBefore
• VARIANT setupString

Return type: IDispatch *

Function removePage

void PHXDATAEXPLORERLib::_DPHXDataExplorer::removePage(long page)

Removes the requested page from the Data Explorer.

Parameters:

• page: The 0 based index of the page to remove.

Parameters:

• long page

Return type: void

Function movePage

void PHXDATAEXPLORERLib::_DPHXDataExplorer::movePage(long page, long insertBefore)

Moves a page within the Data Explorer.

Parameters:

• page: The 0 based index of the page to move.
• insertBefore: The 0 based index of where to put the page. May be -1 to put the page at the end.

Parameters:

• long page
• long insertBefore

Return type: void

Function selectPage

void PHXDATAEXPLORERLib::_DPHXDataExplorer::selectPage(long page)

Selects and makes visible the requested page.

Parameters:

• page: The 0 based index of the page to select.

Parameters:

• long page

Return type: void

Function getSelectedPage

long PHXDATAEXPLORERLib::_DPHXDataExplorer::getSelectedPage()

Returns a 0 based index to which page is currently selected. Returns:

The index of the currently selected page.

Return type: long

Function pageCut

void PHXDATAEXPLORERLib::_DPHXDataExplorer::pageCut(long index)

Causes the "page template" for the selected page to be put on the clipboard and the page to be removed.

Parameters:

• index: The 0 based index of the page to cut.

Parameters:

• long index

Return type: void

Function pageCopy

void PHXDATAEXPLORERLib::_DPHXDataExplorer::pageCopy(long index)

Causes the "page template" for the selected page to be put on the clipboard.

Parameters:

• index: The 0 based index of the page to copy.

Parameters:

• long index

Return type: void

Function pagePaste

void PHXDATAEXPLORERLib::_DPHXDataExplorer::pagePaste()

Causes the page template currently on the clipboard to be pasted into the Data Explorer.

Return type: void

Function invokeInsertPageGUI

void PHXDATAEXPLORERLib::_DPHXDataExplorer::invokeInsertPageGUI()

Causes the "Add New Page" dialog to be presented to the user the same as if they had clicked on "Add Page/Chart"

Return type: void

Function toXMLFile

void PHXDATAEXPLORERLib::_DPHXDataExplorer::toXMLFile(BSTR fileName, [optional]VARIANT includeRunData)

Saves the current state of the Data Explorer and all the included meta-data and pages to an XML file.

Parameters:

• fileName: The file to save to.
• includeRunData:
  

Parameters:

• BSTR fileName
• [optional] VARIANT includeRunData

Return type: void

Function getPageType

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageType(long page)

Gets the type of page for the requested page. May be a COM Application ID (such as PHXCarpetPlot.Application) or a name as registered with ModelCenter's PlugIn Manager's Data Explorer Plug-Ins section (such as "Carpet Plot").

Parameters:

• page: The 0 based index to the requested page.

Returns:

The type of the requested page.

Parameters:

• long page

Return type: BSTR

Function fromXMLFile

void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXMLFile(BSTR fileName, [optional]VARIANT root)

Loads the contents of the Data Explorer from an XML file.

Parameters:

• fileName: The filename of the file to load.
• root: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data Explorer node as a child.

Parameters:

• BSTR fileName
• [optional] VARIANT root

Return type: void

Function toXML

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::toXML([optional]VARIANT includeRunData)

Saves the current state of the Data Explorer and all the included meta-data and pages to an XML string.

Parameters:

• includeRunData:
  

Returns:

An XML string representing the Data Explorer's state.

Parameters:

• [optional] VARIANT includeRunData

Return type: BSTR

Function fromXML

void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXML(BSTR xml, [optional] VARIANT root)

Loads the contents of the Data Explorer from an XML string.

Parameters:

• xml: The XML data to load.
• root: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data Explorer node as a child.

Parameters:

• BSTR xml
• [optional] VARIANT root

Return type: void

Function getMenuItems

void PHXDATAEXPLORERLib::_DPHXDataExplorer::getMenuItems(LPDISPATCH iPHXMenuItem)

Deprecated:

Deprecated. Do not use.

Parameters:

• LPDISPATCH iPHXMenuItem

Return type: void

Function invokeMenuItem

void PHXDATAEXPLORERLib::_DPHXDataExplorer::invokeMenuItem(long id)

Deprecated:

Deprecated. Do not use.

Parameters:

• long id

Return type: void

Function isMenuItemEnabled

boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::isMenuItemEnabled(long id)

Deprecated:

Deprecated. Do not use.

Parameters:

• long id

Return type: boolean

Function updateThumbHint

void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateThumbHint(long id)

Deprecated:

Deprecated. Do not use.

Parameters:

• long id

Return type: void

Function getPageSetup

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageSetup(long page)

Get the setup string for a page. This is exactly what the page returns from its toString() method.

Parameters:

• page: The 0 based index of the page to query.

Returns:

Returns the setup string for a page.

Parameters:

• long page

Return type: BSTR

Function exportImage

void PHXDATAEXPLORERLib::_DPHXDataExplorer::exportImage(long page, BSTR hints, BSTR filename)

Causes a page to export an image to an enhanced metafile (emf) file.

Parameters:

• page: The page number to export.
• hints: Unused.
• filename: The filename to write.

Parameters:

• long page
• BSTR hints
• BSTR filename

Return type: void

Function multiPageCut

void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiPageCut(VARIANT index)

Cuts multiple pages to the clipboard. Parameters:

• index: String containing a comma seperated list of the indices of the pages to be cut.

Parameters:

• VARIANT index

Return type: void

Function multiPageCopy

void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiPageCopy(VARIANT index)

Causes the comma-separated "page templates" for the selected indices to be put on the clipboard. Parameters:

• index: Indices of the pages.

Parameters:

• VARIANT index

Return type: void

Function multiDelete

void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiDelete(VARIANT index)

Deletes the comma-separated "page templates" for the selected indices. Parameters:

• index: Indices of the pages.

Parameters:

• VARIANT index

Return type: void

Function loadTemplate

void PHXDATAEXPLORERLib::_DPHXDataExplorer::loadTemplate(BSTR str)

Causes the DataExplorer to remove all current pages, then import an XML document that describes new pages to display.

Parameters:

• str: The filename to load.

Parameters:

• BSTR str

Return type: void

Function saveTemplate

void PHXDATAEXPLORERLib::_DPHXDataExplorer::saveTemplate(BSTR str)

Causes the DataExplorer to export an XML document describing the current pages.

Parameters:

• str: The filename to write.

Parameters:

• BSTR str

Return type: void

Function toXMLSaveContext

void PHXDATAEXPLORERLib::_DPHXDataExplorer::toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData)

Writes the Data History contents to an XML file.

Parameters:

• saveContext: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML.
• includeRunData:
  

Parameters:

• LPDISPATCH saveContext
• [optional] VARIANT includeRunData

Return type: void

Function fromXMLSaveContext

void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root)

Tells the Data History to load its state from the XML file passed in.

Parameters:

• saveContext: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML.
  
• root: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child.

Parameters:

• LPDISPATCH saveContext
• [optional] VARIANT root

Return type: void

Function show

void PHXDATAEXPLORERLib::_DPHXDataExplorer::show()

Show the associated window.

Return type: void

Function hide

void PHXDATAEXPLORERLib::_DPHXDataExplorer::hide()

Hide the associated window.

Return type: void

Function getPageTitle

BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageTitle(long page)

Get the title for the specified page.

Parameters:

• long page

Return type: BSTR

Private functions

Function fromCenterLink

void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromCenterLink(BSTR server, BSTR runMatrixID, BSTR userName, BSTR password)

Parameters:

• BSTR server
• BSTR runMatrixID
• BSTR userName
• BSTR password

Return type: void

Function ignoreDefaultPlotSetup

boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::ignoreDefaultPlotSetup()

Return type: boolean

Function setupPlotsPre

void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPre()

Return type: void

Function setupPlotsPost

void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPost()

Return type: void

Function showGeomTooltip

void PHXDATAEXPLORERLib::_DPHXDataExplorer::showGeomTooltip(long run, long x, long y)

Parameters:

• long run
• long x
• long y

Return type: void

Function showGeomViewer

void PHXDATAEXPLORERLib::_DPHXDataExplorer::showGeomViewer(long run, long x, long y)

Parameters:

• long run
• long x
• long y

Return type: void

Function updateGeomViewerHint

void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateGeomViewerHint(long viewerID)

Parameters:

• long viewerID

Return type: void

Function setGeomViewerRunID

void PHXDATAEXPLORERLib::_DPHXDataExplorer::setGeomViewerRunID(long viewerID, long runID)

Parameters:

• long viewerID
• long runID

Return type: void

Function updateComparisonViewHint

void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateComparisonViewHint(BOOL restore)

Parameters:

• BOOL restore

Return type: void

Function isMenuItemChecked

boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::isMenuItemChecked(long id)

Parameters:

• long id

Return type: boolean

Function removeFromComparisonList

void PHXDATAEXPLORERLib::_DPHXDataExplorer::removeFromComparisonList(long runID)

Parameters:

• long runID

Return type: void

Function addToComparisonList

void PHXDATAEXPLORERLib::_DPHXDataExplorer::addToComparisonList(long runID)

Parameters:

• long runID

Return type: void

Function addRunsToComparisonList

void PHXDATAEXPLORERLib::_DPHXDataExplorer::addRunsToComparisonList(VARIANT runIDs)

Parameters:

• VARIANT runIDs

Return type: void

Function getDaXType

boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXType()

Return type: boolean

Function getDaXFormat

boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXFormat()

Return type: boolean

Function ensureRunDataAction

void PHXDATAEXPLORERLib::_DPHXDataExplorer::ensureRunDataAction()

Return type: void

Function getKeepalive

IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getKeepalive()

Return type: IDispatch *

Function getHWND

long PHXDATAEXPLORERLib::_DPHXDataExplorer::getHWND()

Return type: long