ArcGIS Runtime SDK for iOS
100.15
|
A KML Network Link element.
An instance of this class represents a KML <NetworkLink> element which references a KML file or KMZ archive on a local or remote network.
Instance Methods | |
(instancetype) | - initWithURL: |
(void) | - refresh |
(id< AGSCancelable >) | - saveToFileURL:completion: |
Class Methods | |
(instancetype) | + KMLNetworkLinkWithURL: |
(instancetype) | + KMLNode |
Properties | |
NSString * | address |
AGSColor * | balloonBackgroundColor |
NSString * | balloonContent |
BOOL | canFlyToNode |
NSArray< AGSKMLNode * > * | childNodes |
AGSEnvelope * | extent |
BOOL | hasRefreshVisibility |
BOOL | highlighted |
AGSKMLStyle * | highlightStyle |
AGSKMLListItemType | listItemType |
NSString * | name |
NSString * | nodeDescription |
NSString * | nodeID |
BOOL | open |
AGSKMLNode * | parentNode |
BOOL | partiallyVisible |
NSError * | refreshError |
NSTimeInterval | refreshInterval |
AGSKMLRefreshMode | refreshMode |
AGSKMLRefreshStatus | refreshStatus |
NSString * | snippet |
NSInteger | snippetMaxLines |
AGSKMLStyle * | style |
AGSTimeExtent * | timeExtent |
NSURL * | URL |
AGSImage * | UXIcon |
AGSColor * | UXIconColor |
NSInteger | UXIconID |
AGSKMLViewpoint * | viewpoint |
AGSKMLViewRefreshMode | viewRefreshMode |
NSTimeInterval | viewRefreshTime |
BOOL | visible |
- (instancetype) initWithURL: | (NSURL *) | URL |
Initialize a KML network link with URL to a KML/KMZ file on the web or on disk.
URL | to a KML/KMZ file on the web or on disk. |
+ (instancetype) KMLNetworkLinkWithURL: | (NSURL *) | URL |
Initialize a KML network link with URL to a KML/KMZ file on the web or on disk.
URL | to a KML/KMZ file on the web or on disk. |
+ (instancetype) KMLNode |
- (void) refresh |
|
readwritenonatomiccopyinherited |
The address of the KML node. Represents an unstructured address such as a street, city, state address, and/or a postal code.
|
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.
|
readwritenonatomicassign |
Indicates whether the app should zoom to the viewpoint defined on the associated <NetworkLinkControl> or the network links' top-level
<kml> node upon refresh of the link.
|
readnonatomiccopy |
The KML network link's child nodes. When the network link is successfully refreshed, this array gets populated with new nodes. The child node changes can be monitored using Key-Value Observing (KVO).
|
readnonatomicstronginherited |
The KML node's bounding extent.
|
readwritenonatomicassign |
Indicates whether Runtime should attempt to maintain the visibility selection of child nodes in the network link after refresh. If true
, Runtime will attempt to maintain any visibility selection for the network link's child nodes after refresh. This is the default behavior when refreshVisibility
is 0
or unset in the source KML file.
|
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
|
readwritenonatomicassign |
Specifies the network link's list item type, which defines how child nodes behave when setting visibility.
|
readwritenonatomiccopyinherited |
The name of the KML node.
|
readwritenonatomiccopyinherited |
The description of the KML node.
|
readwritenonatomiccopyinherited |
The ID of the KML node.
|
readwritenonatomicassign |
Indicates whether the node representing this network link in a table of contents view should be displayed expanded or open.
|
readnonatomicstronginherited |
The KML node's parent or nil
if the node is a root node.
|
readnonatomicassign |
Indicates whether the KML nodes in this container have mixed visibility.
|
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).
|
readwritenonatomicassign |
|
readwritenonatomicassign |
The KML network link refresh mode.
|
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.
|
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
|
readwritenonatomicstrong |
The URL of the KML network link. After setting a new URL, call refresh
to get the new data. If the refresh mode of the network link is AGSKMLRefreshModeOnInterval
when the URL is changed, the refresh operation executed on the following interval will use the new URL value.
|
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).
|
readwritenonatomicassign |
The KML network link view refresh mode.
|
readwritenonatomicassign |
|
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.