IPresentationItem80

This interface provides access to individual presentation items (actions and steps).

 

Properties
	FirstChild	An IPresentationItem80 that describes the first action below a presentation step or the first step in the presentation.
	ID	Gets a presentation item’s ID.
	ItemJSON	Gets a JSON describing a presentation item.
	NextSibling	An IPresentationItem80 representing the next action under a presentation step, or the next step in the presentation.
	Parent	An IPresentationItem80 representing the parent step of a presentation action.
	PreviousSibling	An IPresentationItem80 representing the previous action under a presentation step, or the previous step in a presentation.
	Type	An enum that determines whether the presentation item is a step or action.
Methods
	IsParentOf	Returns a Boolean that determines whether a presentation step is the parent of the specified presentation action, i.e., that the presentation action is under this step.

 

FirstChild

An IPresentationItem80 that describes the first action below a presentation step or the first step in the presentation.

 

JavaScript
FirstChild

 

C#
IPresentationItem80 FirstChild { get; }

 

C++
HRESULT FirstChild ([out, retval] IPresentationItem80* pVal)

 

ID

Gets a presentation item’s ID.

 

JavaScript
ID

 

C#
string ID { get; }

 

C++
HRESULT ID ([out, retval] BSTR* pVal)

 

ItemJSON

Gets and sets a JSON describing a presentation item. This property can be used to update a presentation item or to retrieve a JSON that defines one of the actions or steps in a presentation created in the TerraExplorer user interface. See “Presentations” chapter in the TerraExplorer User Manual. When creating a presentation using the API, the JSON must be written according to the schema defined in PresentationJSONSchema.

If the item is an action the JSON must include the following four properties.

§   description – Name of the item as displayed in the Presentation Editor

§   id – Item ID

§   actionType

§   options

If it is a step then it is a JSON that may contain several actions.

 

For example:

 

{

                        "description": "Fly to: [-81.4987, 41.0084]",

                        "actionType": "FlyTo",

                        "options": {

                            "poi": {

                                "x": -81.498679,

                                "y": 41.008367,

                                "altitude": 302.502045,

                                "viewerYaw": 382.596884,

                                "viewerPitch": -32.975953,

                                "distance": 6809.840545,

                                "isRelative": false

                            }

                        }

                    }

 

JavaScript
ItemJSON

 

C#
string ItemJSON { get; set; }

 

C++
HRESULT ItemJSON ([in] BSTR pVal) HRESULT ItemJSON ([out, retval] BSTR pVal)

 

NextSibling

An IPresentationItem80 representing the next action under a presentation step, or the next step in the presentation.

 

JavaScript
NextSibling

 

C#
IPresentationItem80 NextSibling { get; }

 

C++
HRESULT NextSibling ([out, retval] IPresentationItem80* pVal)

 

Parent

An IPresentationItem80 representing the parent step of a presentation action.

 

JavaScript
Parent

 

C#
IPresentationItem80 Parent { get; }

 

C++
HRESULT Parent ([out, retval] IPresentationItem80* pVal)

 

PreviousSibling

An IPresentationItem80 representing the previous action under a presentation step, or the previous step in a presentation.

 

JavaScript
PreviousSibling

 

C#
IPresentationItem80 PreviousSibling { get; }

 

C++
HRESULT PreviousSibling ([out, retval] IPresentationItem80* pVal)

 

Type

An enum that determines whether the presentation item is a step or action:

§   PIT_STEP = 0,

§   PIT_ACTION = 1

Presentations are created from a combination of actions and steps. Actions are the specific activities that the presentation tool is to perform when the presentation is played, such as 'Record Route' or 'Show Object'. While steps are like "chapter headings" that group together related actions and provide increased flexibility for displaying a presentation by enabling you to quickly jump from one step to another in the presentation.

 

JavaScript
Type

 

C#
PresentationItemType Type { get; }

 

C++
HRESULT Type ([out, retval] PresentationItemType* pVal)

 

IsParentOf

Returns a Boolean that determines whether a presentation step is the parent of the specified presentation action, i.e., that the presentation action is under this step.

 

JavaScript
IsParentOf(        PresentationItemID)

 

C#
bool IsParentOf (        String PresentationItemID)

 

C++
HRESULT IsParentOf (        [in] BSTR PresentationItemID,        [out, retval] VARIANT_BOOL* pVal)

Parameters

PresentationItemID

The ID of the presentation action whose parent is being checked.

Return Value

pVal

A Boolean that determines whether a presentation step is the parent of the specified presentation action, i.e., that the presentation action is under this step.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.