Install in Dash
MGLShapeSource Class Reference
MGLShapeSource
@interface MGLShapeSource : MGLSourceMGLShapeSource is a map content source that supplies vector shapes to be
shown on the map. The shapes may be instances of MGLShape or MGLFeature,
or they may be defined by local or external
GeoJSON code. A shape source is added to an
MGLStyle object along with an MGLVectorStyleLayer object. The vector style
layer defines the appearance of any content supplied by the shape source.
Each
geojson
source defined by the style JSON file is represented at runtime by an
MGLShapeSource object that you can use to refine the map’s content and
initialize new style layers. You can also add and remove sources dynamically
using methods such as -[MGLStyle addSource:] and
-[MGLStyle sourceWithIdentifier:].
Any vector style layer initialized with a shape source should have a nil
value in its sourceLayerIdentifier property.
Example
var coordinates: [CLLocationCoordinate2D] = [
CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
]
let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
let source = MGLShapeSource(identifier: lines
, features: [polyline], options: nil)
mapView.style?.addSource(source)
-
Returns a shape source with an identifier, URL, and dictionary of options for the source.
Declaration
Objective-C
- (nonnull instancetype) initWithIdentifier:(nonnull NSString *)identifier URL:(nonnull NSURL *)url options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;Swift
init(identifier: String, url: URL, options: [MGLShapeSourceOption : Any]? = nil)Parameters
identifierA string that uniquely identifies the source.
URLAn HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle.
optionsAn
NSDictionaryof options for this source.Return Value
An initialized shape source.
-
Returns a shape source with an identifier, a shape, and dictionary of options for the source.
To specify attributes about the shape, use an instance of an
MGLShapesubclass that conforms to theMGLFeatureprotocol, such asMGLPointFeature. To include multiple shapes in the source, use anMGLShapeCollectionorMGLShapeCollectionFeatureobject, or use the-initWithIdentifier:features:options:or-initWithIdentifier:shapes:options:methods.To create a shape from GeoJSON source code, use the
+[MGLShape shapeWithData:encoding:error:]method.Declaration
Objective-C
- (nonnull instancetype) initWithIdentifier:(nonnull NSString *)identifier shape:(nullable MGLShape *)shape options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;Swift
init(identifier: String, shape: MGLShape?, options: [MGLShapeSourceOption : Any]? = nil)Parameters
identifierA string that uniquely identifies the source.
shapeA concrete subclass of
MGLShapeoptionsAn
NSDictionaryof options for this source.Return Value
An initialized shape source.
-
Returns a shape source with an identifier, an array of features, and a dictionary of options for the source.
Unlike
-initWithIdentifier:shapes:options:, this method acceptsMGLFeatureinstances, such asMGLPointFeatureobjects, whose attributes you can use when applying a predicate toMGLVectorStyleLayeror configuring a style layer’s appearance.To create a shape from GeoJSON source code, use the
+[MGLShape shapeWithData:encoding:error:]method.Declaration
Objective-C
- (nonnull instancetype) initWithIdentifier:(nonnull NSString *)identifier features:(nonnull NSArray<MGLShape<MGLFeature> *> *)features options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;Swift
convenience init(identifier: String, features: [MGLShape], options: [MGLShapeSourceOption : Any]? = nil)Parameters
identifierA string that uniquely identifies the source.
featuresAn array of objects that conform to the MGLFeature protocol.
optionsAn
NSDictionaryof options for this source.Return Value
An initialized shape source.
-
Returns a shape source with an identifier, an array of shapes, and a dictionary of options for the source.
Any
MGLFeatureinstance passed into this initializer is treated as an ordinary shape, causing any attributes to be inaccessible to anMGLVectorStyleLayerwhen evaluating a predicate or configuring certain layout or paint attributes. To preserve the attributes associated with each feature, use the-initWithIdentifier:features:options:method instead.To create a shape from GeoJSON source code, use the
+[MGLShape shapeWithData:encoding:error:]method.Declaration
Objective-C
- (nonnull instancetype) initWithIdentifier:(nonnull NSString *)identifier shapes:(nonnull NSArray<MGLShape *> *)shapes options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;Swift
convenience init(identifier: String, shapes: [MGLShape], options: [MGLShapeSourceOption : Any]? = nil)Parameters
identifierA string that uniquely identifies the source.
shapesAn array of shapes; each shape is a member of a concrete subclass of MGLShape.
optionsAn
NSDictionaryof options for this source.Return Value
An initialized shape source.
View Source on GitHub
-
The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a collection of features.
If the receiver was initialized using
-initWithIdentifier:URL:options:, this property is set tonil. This property is unavailable until the receiver is passed into-[MGLStyle addSource:]. -
The URL to the GeoJSON document that specifies the contents of the source.
If the receiver was initialized using
-initWithIdentifier:shape:options:, this property is set tonil.Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSURL *URL;Swift
var url: URL? { get set }