ArcGIS Runtime SDK for iOS
100.15
|
A KML Ground Overlay element.
An instance of this class represents a KML <GroundOverlay> element which draws an image draped onto the terrain.
Instance Methods | |
(nullable instancetype) | - initWithGeometry:icon: |
(id< AGSCancelable >) | - saveToFileURL:completion: |
Class Methods | |
(nullable instancetype) | + KMLGroundOverlayWithGeometry:icon: |
(instancetype) | + KMLNode |
Properties | |
NSString * | address |
double | altitude |
AGSKMLAltitudeMode | altitudeMode |
AGSColor * | balloonBackgroundColor |
NSString * | balloonContent |
AGSColor * | color |
NSInteger | drawOrder |
AGSEnvelope * | extent |
AGSGeometry * | geometry |
BOOL | highlighted |
AGSKMLStyle * | highlightStyle |
AGSKMLIcon * | icon |
NSString * | name |
NSString * | nodeDescription |
NSString * | nodeID |
AGSKMLNode * | parentNode |
NSError * | refreshError |
AGSKMLRefreshStatus | refreshStatus |
double | rotation |
NSString * | snippet |
NSInteger | snippetMaxLines |
AGSKMLStyle * | style |
AGSTimeExtent * | timeExtent |
AGSImage * | UXIcon |
AGSColor * | UXIconColor |
NSInteger | UXIconID |
AGSKMLViewpoint * | viewpoint |
BOOL | visible |
- (nullable instancetype) initWithGeometry: | (AGSGeometry *) | geometry | |
icon: | (nullable AGSKMLIcon *) | icon | |
Initialize a new ground overlay. The specified geometry must be either an AGSEnvelope
or an AGSPolygon
with exactly 4 points. Other geometry types are not supported.
geometry | of the ground overlay |
icon | of the ground overlay. If nil is passed, a geometry is drawn using the defined color . |
+ (nullable instancetype) KMLGroundOverlayWithGeometry: | (AGSGeometry *) | geometry | |
icon: | (nullable AGSKMLIcon *) | icon | |
Initialize a new ground overlay. The specified geometry must be either an AGSEnvelope
or an AGSPolygon
with exactly 4 points. Other geometry types are not supported.
geometry | of the ground overlay |
icon | of the ground overlay. If nil is passed, a geometry is drawn using the defined color . |
+ (instancetype) KMLNode |
|
readwritenonatomiccopyinherited |
The address of the KML node. Represents an unstructured address such as a street, city, state address, and/or a postal code.
|
readwritenonatomicassign |
The KML ground overlay's altitude in meters. Interpreted in terms of altitudeMode
.
|
readwritenonatomicassign |
Specifies how the altitude
value is interpreted. Ground overlays support Absolute and ClampToGround.
|
readnonatomicstronginherited |
The KML node's balloon background color, which should be used when showing a popup.
balloonContent
, such as the border and background of a Callout.
|
readnonatomiccopyinherited |
The content that should be displayed in a balloon popup of the KML node as HTML.
|
readwritenonatomicstrong |
A color mask that is used to blend the image associated with ground overlay. Pixels in the overlay image are multiplied by this color channel-by-channel. At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.
|
readwritenonatomicassign |
The KML ground overlay's draw order. It defines the stacking order for the images in overlapping overlays. Overlays with higher drawOrder values are drawn on top of overlays with lower drawOrder values.
|
readnonatomicstronginherited |
The KML node's bounding extent.
|
readwritenonatomicstrong |
Specifies the geographic location for the ground overlay.
|
readwritenonatomicassigninherited |
Indicates whether the KML node is highlighted. This controls whether the default style or an alternate 'highlighted' style (if present) is used for rendering the node.
|
readwritenonatomicstronginherited |
The KML node's highlight style. This style is used when the KML node has been highlighted / selected.
AGSKMLStyle
|
readwritenonatomicstrong |
The KML ground overlay's icon.
|
readwritenonatomiccopyinherited |
The name of the KML node.
|
readwritenonatomiccopyinherited |
The description of the KML node.
|
readwritenonatomiccopyinherited |
The ID of the KML node.
|
readnonatomicstronginherited |
The KML node's parent or nil
if the node is a root node.
|
readnonatomicstronginherited |
The error that was encountered during the most recent KML node refresh operation. Will be nil if the operation succeeded. The refresh error changes can be monitored using Key-Value Observing (KVO).
|
readnonatomicassigninherited |
The refresh status of the KML node. The refresh status changes can be monitored using Key-Value Observing (KVO). Use this to update the node's properties and application UI. Please take following actions for different refresh statuses, AGSKMLRefreshStatusNone - No action required. AGSKMLRefreshStatusInProgress - Application may show an appropriate UI, such as a spinning wheel on top of the node's table of contents (TOC) icon to indicate in progress status and to restrict user interaction with the node. AGSKMLRefreshStatusCompleted - Read and update the node's properties and its children. The AGSKMLNetworkLink::childNodes
changes can be monitored using Key-Value Observing (KVO). AGSKMLRefreshStatusFailed - Check refreshError
to get the reason for failure and show the error message. Also, applications may show an appropriate UI cue such as a red X with the node's TOC icon to indicate the failed status.
|
readwritenonatomicassign |
The rotation angle (in degrees) of the KML ground overlay about its center. Ranges from -180 to +180 degrees. The default is 0 (North). Rotations are specified in a counterclockwise direction.
|
readwritenonatomiccopyinherited |
The KML node's snippet, if specified.
|
readwritenonatomicassigninherited |
The maximum number of lines of snippet to be shown in the UI.
|
readwritenonatomicstronginherited |
|
readwritenonatomicstronginherited |
The KML node's time extent.
Represents the AGSTimeExtent
equivalent of a KML node's TimeStamp or TimeSpan. An AGSKMLContainer
node such as AGSKMLDocument
or AGSKMLFolder
may have its own AGSTimeExtent
independent of its child nodes. All KML TimeStamps and TimeSpans specified in a KML/KMZ file are converted to their UTC AGSTimeExtent
equivalents.
Examples:
KML TimeStamp | AGSTimeExtent::startTime | AGSTimeExtent::endTime |
---|---|---|
2021 | 2021-01-01T00:00:00 | 2021-12-31T23:59:59 |
2021-01 | 2021-01-01T00:00:00 | 2021-01-31T23:59:59 |
2021-01-01 | 2021-01-01T00:00:00 | 2021-01-01T23:59:59 |
2021-01-01T12:34:56 | 2021-01-01T12:34:56 | 2021-01-01T12:34:56 |
KML TimeSpan | AGSTimeExtent::startTime | AGSTimeExtent::endTime |
---|---|---|
2021 - 2022 | 2021-01-01T00:00:00 | 2022-12-31T23:59:59 |
2021-01 - 2021-02 | 2021-01-01T00:00:00 | 2021-02-28T23:59:59 |
No beginning - 2021 | Infinite start time | 2021-12-31T23:59:59 |
2021 - No end | 2021-01-01T00:00:00 | Infinite end time |
AGSTimeExtent
|
readnonatomicstronginherited |
The KML node's UX icon. Use this icon to represent the KML node in the table of contents (TOC) or anywhere else you need to display the node in the UI. The icon changes can be monitored using Key-Value Observing (KVO).
|
readnonatomicstronginherited |
The color mask that can be used to blend the image associated with UXIcon
. Pixels in the image are multiplied by this color channel-by-channel.
nil
), you can use the icon color to draw a placeholder image in the UI (for example, the TOC). UXIcon
; it is the application's responsibility to tint the image before displaying it.
|
readnonatomicassigninherited |
The ID of KML node's UX icon.
|
readwritenonatomicstronginherited |
The KML node's viewpoint, or nil
if no Camera or LookAt viewpoint is specified on the node. It specifies the vantage point for looking at the node. This can be used to show a particular node in the view (for example, if a user selected it in a TOC).
|
readwritenonatomicassigninherited |
Indicates whether the KML node is visible or not.
true
. Changing the visibility of one node may affect the other nodes in the dataset's node hierarchy, including child nodes.