- Since:
- 100.4.0
-
Property Summary
TypePropertyDescriptionThe color mask to be applied to the KML ground overlay's image.Properties inherited from class com.esri.arcgisruntime.ogc.kml.KmlNode
balloonBackgroundColor, uxIconColor
-
Nested Class Summary
Nested classes/interfaces inherited from class com.esri.arcgisruntime.ogc.kml.KmlNode
KmlNode.RefreshStatus
-
Constructor Summary
ConstructorDescriptionKmlGroundOverlay
(Geometry geometry, KmlIcon kmlIcon) Creates a KML ground overlay with the specified geometry and icon. -
Method Summary
Modifier and TypeMethodDescriptionThe color mask to be applied to the KML ground overlay's image.double
Gets the KML ground overlay's altitude in meters.Gets the altitude mode of the ground overlay.getColor()
Gets the value of thecolor
property.int
Gets the KML ground overlay's draw order.Gets the geometry for the KML ground overlay.getIcon()
Gets the KML ground overlay icon.double
Gets the KML ground overlay's rotation.void
setAltitude
(double altitude) Sets the KML ground overlay's altitude.void
setAltitudeMode
(KmlAltitudeMode kmlAltitudeMode) Sets the altitude mode of the ground overlay.void
setColor
(int color) Deprecated, for removal: This API element is subject to removal in a future version.void
Sets the value of thecolor
property.void
setDrawOrder
(int drawOrder) Sets the KML ground overlay's draw order.void
setGeometry
(Geometry geometry) Sets the geometry of the KML ground overlay.void
Sets the KML ground overlay icon.void
setRotation
(double rotation) Sets the rotation of the KML ground overlay.Methods inherited from class com.esri.arcgisruntime.ogc.kml.KmlNode
addIconUpdatedEventListener, addRefreshStatusChangedListener, balloonBackgroundColorProperty, getAddress, getBalloonBackgroundColor, getBalloonContent, getDescription, getExtent, getHighlightStyle, getId, getName, getParentNode, getRefreshError, getRefreshStatus, getSnippet, getSnippetMaxLines, getStyle, getTimeExtent, getUxIcon, getUxIconColor, getUxIconId, getViewpoint, isHighlighted, isVisible, removeIconUpdatedEventListener, removeRefreshStatusChangedListener, saveAsAsync, setAddress, setDescription, setHighlighted, setHighlightStyle, setId, setName, setSnippet, setSnippetMaxLines, setStyle, setTimeExtent, setViewpoint, setVisible, uxIconColorProperty
-
Property Details
-
color
The color mask to be applied to the KML ground overlay's image.Pixels in the overlay image are multiplied by this color channel-by-channel.
The default value is
Color.WHITE
.At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.
- Since:
- 200.0.0
- See Also:
-
-
Constructor Details
-
KmlGroundOverlay
Creates a KML ground overlay with the specified geometry and icon.The specified geometry must be either an
Envelope
or aPolygon
with exactly 4 points. Other geometry types are not supported.- Parameters:
geometry
- a GeometrykmlIcon
- a KmlIcon- Throws:
IllegalArgumentException
- if geometry is nullIllegalArgumentException
- if kmlIcon is nullArcGISRuntimeException
- if geometry is not an Envelope or Polygon with four points- Since:
- 100.6.0
-
-
Method Details
-
getAltitude
public double getAltitude()Gets the KML ground overlay's altitude in meters. Interpreted in terms ofgetAltitudeMode()
.- Returns:
- the KML ground overlay's altitude in meters
- Since:
- 100.4.0
-
getAltitudeMode
Gets the altitude mode of the ground overlay.Ground overlays support
KmlAltitudeMode.ABSOLUTE
andKmlAltitudeMode.CLAMP_TO_GROUND
.- Returns:
- the altitude mode of the ground overlay
- Since:
- 100.4.0
-
setAltitudeMode
Sets the altitude mode of the ground overlay.Ground overlays support
KmlAltitudeMode.ABSOLUTE
andKmlAltitudeMode.CLAMP_TO_GROUND
.- Parameters:
kmlAltitudeMode
- a KmlAltitudeMode- Throws:
IllegalArgumentException
- if kmlAltitudeMode is nullArcGISRuntimeException
- if an unsupported altitude mode is used- Since:
- 100.7.0
-
getDrawOrder
public int getDrawOrder()Gets the KML ground overlay's draw order. Overlays with higher draw order values are drawn on top of those with lower values.- Returns:
- the KML ground overlay's draw order
- Since:
- 100.4.0
-
getGeometry
Gets the geometry for the KML ground overlay.- Returns:
- an Envelope geometry for the KML ground overlay
- Since:
- 100.4.0
- See Also:
-
colorProperty
The color mask to be applied to the KML ground overlay's image.Pixels in the overlay image are multiplied by this color channel-by-channel.
The default value is
Color.WHITE
.At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.
- Returns:
- the
color
property - Since:
- 200.0.0
- See Also:
-
getColor
Gets the value of thecolor
property.- Property description:
- The color mask to be applied to the KML ground overlay's image.
Pixels in the overlay image are multiplied by this color channel-by-channel.
The default value is
Color.WHITE
.At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.
- Returns:
- the value of the
color
property - Since:
- 200.0.0
- See Also:
-
setColor
Sets the value of thecolor
property.- Property description:
- The color mask to be applied to the KML ground overlay's image.
Pixels in the overlay image are multiplied by this color channel-by-channel.
The default value is
Color.WHITE
.At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.
- Parameters:
color
- the value for thecolor
property- Since:
- 200.0.0
- See Also:
-
getRotation
public double getRotation()Gets the KML ground overlay's rotation.The rotation of the overlay about its center is in degrees. Values can be in the range of +/-180. The default is 0 (north). Rotations are specified in a counterclockwise direction.
- Returns:
- the KML ground overlay's rotation
- Since:
- 100.4.0
-
getIcon
Gets the KML ground overlay icon.- Returns:
- a KmlIcon
- Since:
- 100.6.0
- See Also:
-
setIcon
Sets the KML ground overlay icon.- Parameters:
kmlIcon
- a KmlIcon- Since:
- 100.6.0
- See Also:
-
setAltitude
public void setAltitude(double altitude) Sets the KML ground overlay's altitude.Specifies the altitude of the overlay in meters. It shall be interpreted according to
KmlAltitudeMode
.- Parameters:
altitude
- the altitude in meters- Since:
- 100.6.0
-
setColor
Deprecated, for removal: This API element is subject to removal in a future version.as of 200.0.0, replaced bysetColor(Color)
Sets the color mask to be applied to the KML ground overlay's image.The color mask is used to blend the image associated with KML ground overlay. Pixels in the overlay image are multiplied by this color channel-by-channel.
- Parameters:
color
- the color (an integer as 0xAARRGGBB) to blend with overlay image- Since:
- 100.6.0
-
setDrawOrder
public void setDrawOrder(int drawOrder) Sets the KML ground overlay's draw order.The draw order defines the stacking order for the images in overlapping overlays. Overlays with higher draw order values are drawn on top of overlays with lower draw order values.
- Parameters:
drawOrder
- draw order of the overlay- Throws:
IllegalArgumentException
- if drawOrder is negative- Since:
- 100.6.0
-
setGeometry
Sets the geometry of the KML ground overlay.The specified geometry must be either an
Envelope
or aPolygon
with exactly 4 points. Other geometry types are not supported.- Parameters:
geometry
- a Geometry- Throws:
ArcGISRuntimeException
- if geometry is not an Envelope or Polygon with four pointsIllegalArgumentException
- if geometry is null- Since:
- 100.6.0
- See Also:
-
setRotation
public void setRotation(double rotation) Sets the rotation of the KML ground overlay.Specifies the rotation of the overlay about its center in degrees. The default is 0 (north). Rotations are specified in a counterclockwise direction.
- Parameters:
rotation
- the rotation of the overlay- Since:
- 100.6.0
-
setColor(Color)