## On this page

  

 

 # Interface PHXDATAEXPLORERLib::\_DPHXDataExplorer

 Last update: 30.07.2026 

![](https://img.shields.io/badge/language-IDL-blue "IDL")![](https://img.shields.io/badge/-public-brightgreen "public")

**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](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1)
- [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af)
- [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87)
- [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960)
- [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b)
- [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e)
- [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c)
- [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414)
- [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d)
- [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9)
- [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12)
- [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd)
- [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f)
- [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d)
- [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06)
- [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012)
- [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817)
- [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394)
- [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f)
- [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6)
- [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f)
- [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4)
- [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187)
- [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c)
- [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5)
- [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8)
- [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6)
- [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094)
- [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652)
- [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893)
- [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a)
- [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca)
- [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f)
- [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5)
- [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4)
- [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592)
- [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece)
- [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da)
- [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d)
- [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7)
- [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42)
- [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd)
- [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826)
- [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3)
- [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6)
- [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924)
- [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134)
- [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305)
- [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68)
- [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b)
- [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d)
- [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c)
- [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa)
- [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6)
- [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd)
- [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec)
- [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8)
- [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70)
- [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22)
- [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c)

## Properties

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e"></a>

### Property author

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::author

```

The author of the data in this Data Explorer.

**Return type**: BSTR

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414"></a>

### Property description

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::description

```

A description of the data in this Data Explorer.

**Return type**: BSTR

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d"></a>

### Property displayName

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::displayName

```

A display name for this Data Explorer.

**Return type**: BSTR

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094"></a>

### Property id

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
tradeStudyType PHXDATAEXPLORERLib::_DPHXDataExplorer::id

```

A pointer to the associated ModelCenter session. Points to a [ModelCenter.Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) or [ModelCenter.IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object.

**Return type**: tradeStudyType

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652"></a>

### Property id

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
tradeStudySetup PHXDATAEXPLORERLib::_DPHXDataExplorer::id

```

A pointer to the included Data History object.

**Return type**: tradeStudySetup

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960"></a>

### Property associatedModelFile

![](https://img.shields.io/badge/-public-brightgreen "public")

**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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b"></a>

### Property associatedModelFileUUID

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFileUUID

```

The UUID of the associated Model.

**Return type**: BSTR

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c"></a>

### Property creationDate

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::creationDate

```

The creation date of the model.

**Return type**: BSTR

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8"></a>

### Property tradeStudyUri

![](https://img.shields.io/badge/-public-brightgreen "public")

**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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4"></a>

### Property isVisible

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```
PHXDATAEXPLORERLib::_DPHXDataExplorer::isVisible

```

Is the window visible?

**Return type**:

## Public functions

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f"></a>

### Function getNumPages

![](https://img.shields.io/badge/-public-brightgreen "public")

```
long PHXDATAEXPLORERLib::_DPHXDataExplorer::getNumPages()

```

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

The number of pages.

**Return type**: long

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4"></a>

### Function getPage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) and may additionally implement other interfaces.

**Parameters**:

- long **page**

**Return type**: IDispatch \*

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1"></a>

### Function addPage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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](namespaceModelCenter.md#namespaceModelCenter)'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()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) call. Format is page dependent.

**Returns**:

The IDispatch of the newly created page. This pointer is guaranteed to implement [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) and may additionally implement other interfaces.

**Parameters**:

- BSTR **type**
- VARIANT **insertBefore**
- VARIANT **setupString**

**Return type**: IDispatch \*

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6"></a>

### Function removePage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece"></a>

### Function movePage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134"></a>

### Function selectPage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8"></a>

### Function getSelectedPage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd"></a>

### Function pageCut

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42"></a>

### Function pageCopy

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826"></a>

### Function pagePaste

![](https://img.shields.io/badge/-public-brightgreen "public")

```
void PHXDATAEXPLORERLib::_DPHXDataExplorer::pagePaste()

```

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

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a"></a>

### Function invokeInsertPageGUI

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd"></a>

### Function toXMLFile

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5"></a>

### Function getPageType

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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](namespaceModelCenter.md#namespaceModelCenter)'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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d"></a>

### Function fromXMLFile

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6"></a>

### Function toXML

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f"></a>

### Function fromXML

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6"></a>

### Function getMenuItems

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

**Deprecated**:

Deprecated. Do not use.

**Parameters**:

- LPDISPATCH **iPHXMenuItem**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca"></a>

### Function invokeMenuItem

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

**Deprecated**:

Deprecated. Do not use.

**Parameters**:

- long **id**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5"></a>

### Function isMenuItemEnabled

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

**Deprecated**:

Deprecated. Do not use.

**Parameters**:

- long **id**

**Return type**: boolean

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c"></a>

### Function updateThumbHint

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

**Deprecated**:

Deprecated. Do not use.

**Parameters**:

- long **id**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187"></a>

### Function getPageSetup

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12"></a>

### Function exportImage

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7"></a>

### Function multiPageCut

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d"></a>

### Function multiPageCopy

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da"></a>

### Function multiDelete

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592"></a>

### Function loadTemplate

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924"></a>

### Function saveTemplate

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec"></a>

### Function toXMLSaveContext

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06"></a>

### Function fromXMLSaveContext

![](https://img.shields.io/badge/-public-brightgreen "public")

```
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

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d"></a>

### Function show

![](https://img.shields.io/badge/-public-brightgreen "public")

```
void PHXDATAEXPLORERLib::_DPHXDataExplorer::show()

```

Show the associated window.

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6"></a>

### Function hide

![](https://img.shields.io/badge/-public-brightgreen "public")

```
void PHXDATAEXPLORERLib::_DPHXDataExplorer::hide()

```

Hide the associated window.

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c"></a>

### Function getPageTitle

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

Get the title for the specified page.

**Parameters**:

- long **page**

**Return type**: BSTR

## Private functions

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd"></a>

### Function fromCenterLink

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- BSTR **server**
- BSTR **runMatrixID**
- BSTR **userName**
- BSTR **password**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893"></a>

### Function ignoreDefaultPlotSetup

![](https://img.shields.io/badge/-private-red "private")

```
boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::ignoreDefaultPlotSetup()

```

**Return type**: boolean

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b"></a>

### Function setupPlotsPre

![](https://img.shields.io/badge/-private-red "private")

```
void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPre()

```

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68"></a>

### Function setupPlotsPost

![](https://img.shields.io/badge/-private-red "private")

```
void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPost()

```

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c"></a>

### Function showGeomTooltip

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **run**
- long **x**
- long **y**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa"></a>

### Function showGeomViewer

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **run**
- long **x**
- long **y**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22"></a>

### Function updateGeomViewerHint

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **viewerID**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305"></a>

### Function setGeomViewerRunID

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **viewerID**
- long **runID**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70"></a>

### Function updateComparisonViewHint

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- BOOL **restore**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f"></a>

### Function isMenuItemChecked

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **id**

**Return type**: boolean

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3"></a>

### Function removeFromComparisonList

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **runID**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87"></a>

### Function addToComparisonList

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- long **runID**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af"></a>

### Function addRunsToComparisonList

![](https://img.shields.io/badge/-private-red "private")

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

```

**Parameters**:

- VARIANT **runIDs**

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817"></a>

### Function getDaXType

![](https://img.shields.io/badge/-private-red "private")

```
boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXType()

```

**Return type**: boolean

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012"></a>

### Function getDaXFormat

![](https://img.shields.io/badge/-private-red "private")

```
boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXFormat()

```

**Return type**: boolean

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9"></a>

### Function ensureRunDataAction

![](https://img.shields.io/badge/-private-red "private")

```
void PHXDATAEXPLORERLib::_DPHXDataExplorer::ensureRunDataAction()

```

**Return type**: void

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f"></a>

### Function getKeepalive

![](https://img.shields.io/badge/-private-red "private")

```
IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getKeepalive()

```

**Return type**: IDispatch \*

<a id="interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394"></a>

### Function getHWND

![](https://img.shields.io/badge/-private-red "private")

```
long PHXDATAEXPLORERLib::_DPHXDataExplorer::getHWND()

```

**Return type**: long