summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-07-10 15:03:42 -0700
committerGitHub <noreply@github.com>2016-07-10 15:03:42 -0700
commit8ca8e2c5093db331d592b8bd4abe695cde2e77ab (patch)
tree1d7d6b6f45d1ed7b80bf473190499e7ce7d63143
parentd0766120ca2513e44584f12014283de4c361372b (diff)
downloadqtlocation-mapboxgl-8ca8e2c5093db331d592b8bd4abe695cde2e77ab.tar.gz
[ios, macos] Updated MGLFeature ID documentation
Since #5514, feature IDs may be integers, unsigned integers, floating-point numbers, or strings, not just unsigned integers.
-rw-r--r--platform/darwin/src/MGLFeature.h18
1 files changed, 14 insertions, 4 deletions
diff --git a/platform/darwin/src/MGLFeature.h b/platform/darwin/src/MGLFeature.h
index 69cff6b054..1ab587ede5 100644
--- a/platform/darwin/src/MGLFeature.h
+++ b/platform/darwin/src/MGLFeature.h
@@ -29,13 +29,23 @@ NS_ASSUME_NONNULL_BEGIN
An object that uniquely identifies the feature in its containing
<a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources">tile source</a>.
- The value of this property is currently always an `NSNumber` object but may in
- the future be an instance of another class, such as `NSString`.
-
The identifier corresponds to the
<a href="https://github.com/mapbox/vector-tile-spec/tree/master/2.1#42-features">feature identifier</a>
(`id`) in the tile source. If the source does not specify the feature’s
- identifier, the value of this property is `nil`.
+ identifier, the value of this property is `nil`. If specified, the identifier
+ may be an integer, floating-point number, or string. These data types are
+ mapped to instances of the following Foundation classes:
+
+ <table>
+ <thead>
+ <tr><th>In the tile source</th><th>This property</th></tr>
+ </thead>
+ <tbody>
+ <tr><td>Integer</td> <td><code>NSNumber</code> (use the <code>unsignedLongLongValue</code> or <code>longLongValue</code> property)</td></tr>
+ <tr><td>Floating-point number</td> <td><code>NSNumber</code> (use the <code>doubleValue</code> property)</td></tr>
+ <tr><td>String</td> <td><code>NSString</code></td></tr>
+ </tbody>
+ </table>
For details about the identifiers used in most Mapbox-provided styles, consult
the