VO KML
Manipulate KML files in the 3D Window.
Syntax
VO <ScenarioPath> KML {KMLOption} <Parameters> [WindowID <WinNumber>]
Related commands
Description
The VO KML command will allow you to add and remove KML files to a 3D Window, and show or hide the features of a KML file.
Valid values for {KMLOption} are: Save, Load, Close, ZoomTo, Visibility.
All VO KML commands can optionally include the WindowID <WinNumber> parameter. If not included, the command will be applied to the first 3d Window.
The following tables describe the additional <Parameters> for each {KMLOption}.
VO KML Save
Save the specified kml file from the globe manager with any optoins that are enabled.
| Save <Parameters> | Description |
|---|---|
| {File "<FilePath>" OutputFile "<OutputFilepath>" {WindowID #}} | The "<FilePath>" is the full file path of the KML file.
The <OutputFilePath> is the location to save the KML file. WindowID is optional. |
VO KML Load
Load the specified kml file into the globe manager.
| Load <Parameters> | Description |
|---|---|
| {File "<FilePath>" | KMLString <String>} | The "<FilePath>" is the full file path of the KML file.
The <String> is an xml string describing a kml object. Do not include quotes around the <String>. The KMLString parameter, if entered, must be the last parameter on the command line. |
VO KML Close
Close the specified file or document in the globe manager.
| Close <Parameters> | Description |
|---|---|
| {File "<FilePath>" | Document "<DocName>"} | Enter the full file path of the KML file or the KML document name. |
VO KML ZoomTo
Set the 3D Window view to the named Feature. This option will also set the Visibility of the Feature to On.
| ZoomTo <Parameters> | Description |
|---|---|
| {File "<FilePath>" | Document "<DocName>"} | Enter the full file path of the KML file or the KML document name.
The File or Document parameter must appear before the Feature parameter. |
| Feature "<FeatureName>" | Enter the "<FeatureName>" to ZoomTo. If a Feature level has no name enter a single space, between the delimiters, for that level. The first unnamed feature at that level will be used. |
| Delimiter <c> | Enter a single character to be used as the delimiter between levels of the FeatureName. The default delimiter is the forward slash "/". This parameter is optional. For more information on this parameter see "Feature Names and Delimiter" below. |
| ShowBalloon {On | Yes | Off | No} | Specify whether the information balloon for the feature, if applicable, should be shown. The default value is On. This parameter is optional. |
VO KML Visibility
Show or hide the named Feature.
| Visibility <Parameters> | Description |
|---|---|
| {File "<FilePath>" | Document "<DocName>"} | Enter the full file path of the KML file or the KML document name.
The File or Document parameter must appear before the Feature parameter. |
| Feature "<FeatureName>" | Enter the "<FeatureName>" to show or hide. If a Feature level has no name enter a single space, between the delimiters, for that level. The first unnamed feature at that level will be used. |
| Visible {On | Yes | Off | No} | Turn on or off visibility. |
| Delimiter <c> | Enter a single character to be used as the delimiter between levels of the FeatureName. The default delimiter is the forward slash "/". This parameter is optional. For more information on this parameter see "Feature Names and Delimiter" below. |
Feature Names and Delimiter
The Feature name must appear in the command as it appears in the kml file. To access a feature at a lower level within the kml, you must specify the name of each level in the hierarchy path separated by a delimiter. The default delimiter is the forward slash "/" (e.g. World/Countries/US) but you may specify a unique character for the delimiter by using the Delimiter parameter.
For best results use the VO_RM KML command to get a list of Feature Names,
The Delimiter can not be a double quote ("), or the backslash (\).
If a Feature level has no name, then enter a single space, between the delimiters, for that level. For example, the following feature has no name for the second level.
Ionops/ /ColorKey
If a Feature name contains a double quote ("), a backslash (\) or the Delimiter, then the double quote, backslash or delimiter character must be preceded by a backslash (\).
If a Feature name contains a newline, tab or other whitespace character, the character representation must be used. For newline enter "\n"; for horizontal tab enter "\t"; for vertical tab enter "\v"; for formfeed enter "\f".
Examples
Examples of feature name specifications:
The Feature name contains the double quote: Glacier, Ice Shelf "Velocity"
The Feature name contains the delimiter (/): Glacier, Ice Shelf/Velocity
The Feature name contains a newline: Glacier, Ice Shelf(newline)Velocity
Examples
Load the specified file on the first 3D Window:
Zoom to the specified feature, using the default delimiter:
Show the specified feature:
Close the kml file:
Load the specified file on the second 3D Window:
This Feature name uses a user specified delimiter (;):
Set the visibility for the Feature on the second 3D window:
Close the kml file on the second 3D window:
To load a kml Point object from a string description:
Return message
Group membership
This command belongs to the following group(s):
Version
9.2