diff options
Diffstat (limited to 'platform/darwin/src/MGLFeature.h')
| -rw-r--r-- | platform/darwin/src/MGLFeature.h | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/platform/darwin/src/MGLFeature.h b/platform/darwin/src/MGLFeature.h index a13821cf96..d0c9e26062 100644 --- a/platform/darwin/src/MGLFeature.h +++ b/platform/darwin/src/MGLFeature.h @@ -11,7 +11,7 @@ NS_ASSUME_NONNULL_BEGIN /** The `MGLFeature` protocol is used to provide details about geographic features - contained in an `MGLShapeSource` or `MGLVectorSource` object. Each concrete + contained in an `MGLShapeSource` or `MGLVectorTileSource` object. Each concrete subclass of `MGLShape` in turn has a subclass that conforms to this protocol. A feature object associates a shape with an optional identifier and attributes. @@ -23,8 +23,8 @@ NS_ASSUME_NONNULL_BEGIN In addition to adding data to the map, you can also extract data from the map: `-[MGLMapView visibleFeaturesAtPoint:]` and related methods return feature objects that correspond to features in the source. This enables you to inspect - the properties of features in vector tiles loaded by `MGLVectorSource` objects. - You also reuse these feature objects as overlay annotations. + the properties of features in vector tiles loaded by `MGLVectorTileSource` + objects. You also reuse these feature objects as overlay annotations. While it is possible to add `MGLFeature`-conforming objects to the map as annotations using `-[MGLMapView addAnnotations:]` and related methods, doing so @@ -43,12 +43,12 @@ NS_ASSUME_NONNULL_BEGIN source. You can configure an `MGLVectorStyleLayer` object to include or exclude a - specific feature in an `MGLShapeSource` or `MGLVectorSource`. In the + specific feature in an `MGLShapeSource` or `MGLVectorTileSource`. In the `MGLVectorStyleLayer.predicate` property, compare the special `$id` attribute to the feature’s identifier. - In vector tiles loaded by `MGLVectorSource` objects, the identifier corresponds - to the + In vector tiles loaded by `MGLVectorTileSource` objects, the identifier + corresponds to the <a href="https://github.com/mapbox/vector-tile-spec/tree/master/2.1#42-features">feature identifier</a> (`id`). If the source does not specify the feature’s identifier, the value of this property is `nil`. If specified, the identifier may be an integer, @@ -83,7 +83,7 @@ NS_ASSUME_NONNULL_BEGIN A dictionary of attributes for this feature. You can configure an `MGLVectorStyleLayer` object to include or exclude a - specific feature in an `MGLShapeSource` or `MGLVectorSource`. In the + specific feature in an `MGLShapeSource` or `MGLVectorTileSource`. In the `MGLVectorStyleLayer.predicate` property, compare a key of the attribute dictionary to the value you want to include. For example, if you want an `MGLLineStyleLayer` object to display only important features, you might assign @@ -107,7 +107,7 @@ NS_ASSUME_NONNULL_BEGIN `MGLSymbolStyleLayer.textField` to an `MGLStyleValue` object containing the raw string value `{name}`. - In vector tiles loaded by `MGLVectorSource` objects, the keys and values of + In vector tiles loaded by `MGLVectorTileSource` objects, the keys and values of each feature’s attribute dictionary are determined by the source. Each attribute name is a string, while each attribute value may be a null value, Boolean value, integer, floating-point number, or string. These data types are @@ -238,11 +238,12 @@ MGL_EXPORT An `MGLShapeCollectionFeature` object associates a shape collection with an optional identifier and attributes. - `MGLShapeCollectionFeature` is most commonly used to add multiple shapes to a single - `MGLShapeSource`. Configure the appearance of an `MGLSource`’s shape collection - collectively using an `MGLSymbolStyleLayer` object, or use multiple instances of - `MGLCircleStyleLayer`, `MGLFillStyleLayer`, and `MGLLineStyleLayer` to - configure the appearance of each kind of shape inside the collection. + `MGLShapeCollectionFeature` is most commonly used to add multiple shapes to a + single `MGLShapeSource`. Configure the appearance of an `MGLSource`’s shape + collection collectively using an `MGLSymbolStyleLayer` object, or use multiple + instances of `MGLCircleStyleLayer`, `MGLFillStyleLayer`, and + `MGLLineStyleLayer` to configure the appearance of each kind of shape inside + the collection. A shape collection feature is known as a <a href="https://tools.ietf.org/html/rfc7946#section-3.3">feature collection</a> |