com.esri.arcgis.globecore
Interface IKmlLayer

All Superinterfaces:

ILayer, Serializable

All Known Implementing Classes:

KmlLayer

public interface IKmlLayer
extends ILayer, Serializable

Provides information about a KML Layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getDataPath() Full pathname of the KML data.
int	getMaximumRefreshInterval() Maximun Refresh interval in seconds.
int	getMinimumRefreshInterval() Minimun Refresh interval in seconds.
boolean	isLabelsVisible() Labels are Visible.
void	refreshVisibleNodes(IGlobe pGlobe) Refresh Visible Nodes.
void	setDataPath(String dataPath) Full pathname of the KML data.
void	setGlobeContainedDataPath(String dataPath, IGlobe rhs2) Full pathname of the KML data within a contained part of Globe.
void	setLabelsVisible(boolean pLabelsVisible) Labels are Visible.

Methods inherited from interface com.esri.arcgis.carto.ILayer

draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible

Method Detail

setDataPath

void setDataPath(String dataPath)
                 throws IOException,
                        AutomationException

Full pathname of the KML data.

Description

To set the DataPath pass in the UNC or local path of your KML file as a string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

dataPath - The dataPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataPath

String getDataPath()
                   throws IOException,
                          AutomationException

Full pathname of the KML data.

Description

DataPath can be the UNC or local path of your KML file as a string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The dataPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshVisibleNodes

void refreshVisibleNodes(IGlobe pGlobe)
                         throws IOException,
                                AutomationException

Refresh Visible Nodes.

Description

This method must be called after the visibility of a KML Node has been changed via the IKmlNode interface.

The call to RefreshVisibleNodes should be followed by calls to invalidate the layer cache and redraw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pGlobe - A reference to a com.esri.arcgis.globecore.IGlobe (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumRefreshInterval

int getMinimumRefreshInterval()
                              throws IOException,
                                     AutomationException

Minimun Refresh interval in seconds.

Description

The KML nodes may have a "<refreshInterval>" tag in the KML file. This method would return the minimum refresh interval value (in seconds) from amongst all the KML nodes in the KML layer.
If none of the nodes has the "<refreshInterval>" tag then the function would return 0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumRefreshInterval

int getMaximumRefreshInterval()
                              throws IOException,
                                     AutomationException

Maximun Refresh interval in seconds.

Description

The KML nodes may have a "<refreshInterval>" tag in the KML file. This method would return the maximum refresh interval value (in seconds) from amongst all the KML nodes in the KML layer.
If none of the nodes has the "<refreshInterval>" tag then the function would return 0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelsVisible

void setLabelsVisible(boolean pLabelsVisible)
                      throws IOException,
                             AutomationException

Labels are Visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pLabelsVisible - The pLabelsVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelsVisible

boolean isLabelsVisible()
                        throws IOException,
                               AutomationException

Labels are Visible.

Description

Placemark elements within a KML layer can display their Name property as a label in the 3D view. KML labels are billboarded to face the camera and use conflict detection in order to avoid overposting with other labels in the same KML layer.

By default, labels are visible for KML layers.

To disable labels for the KML layer set this property to False.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pLabelsVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeContainedDataPath

void setGlobeContainedDataPath(String dataPath,
                               IGlobe rhs2)
                               throws IOException,
                                      AutomationException

Full pathname of the KML data within a contained part of Globe.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

dataPath - The dataPath (in)

rhs2 - A reference to a com.esri.arcgis.globecore.IGlobe (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.