diff options
Diffstat (limited to 'platform/darwin/src/MGLVectorSource.h')
-rw-r--r-- | platform/darwin/src/MGLVectorSource.h | 53 |
1 files changed, 41 insertions, 12 deletions
diff --git a/platform/darwin/src/MGLVectorSource.h b/platform/darwin/src/MGLVectorSource.h index 2106a5cf42..6cfab09489 100644 --- a/platform/darwin/src/MGLVectorSource.h +++ b/platform/darwin/src/MGLVectorSource.h @@ -13,27 +13,56 @@ NS_ASSUME_NONNULL_BEGIN */ @interface MGLVectorSource : MGLSource -@property (nonatomic, readonly, copy) NSURL *URL; -@property (nonatomic, readonly, nullable) MGLTileSet *tileSet; +#pragma mark Initializing a Source /** - Initializes and returns a vector source from a remote URL. + Returns a vector source initialized with an identifier and TileJSON URL. - @param sourceIdentifier The source identifier. - @param URL A remote URL holding the vector source data. + After initializing and configuring the source, add it to a map view’s style + using the `-[MGLStyle addSource:]` method. - @return An `MGLVectorSource`. + @param identifier A string that uniquely identifies the source in the style to + which it is added. + @param url A URL to a TileJSON configuration file describing the source’s + contents and other metadata. + @return An initialized vector source. */ -- (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier URL:(NSURL *)url; +- (instancetype)initWithIdentifier:(NSString *)identifier URL:(NSURL *)url NS_DESIGNATED_INITIALIZER; /** - Initializes a source with the given identifier, tile size, and tile - URL template set. + Returns a vector source initialized an identifier and tile set. - @param sourceIdentifier A string that uniquely identifies the source. - @param tileSet A tile set describing where to download tiles. + After initializing and configuring the source, add it to a map view’s style + using the `-[MGLStyle addSource:]` method. + + @param identifier A string that uniquely identifies the source in the style to + which it is added. + @param tileSet A tile set describing the source’s contents and other metadata. + @return An initialized vector source. */ -- (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier tileSet:(MGLTileSet *)tileSet; +- (instancetype)initWithIdentifier:(NSString *)identifier tileSet:(MGLTileSet *)tileSet NS_DESIGNATED_INITIALIZER; + +#pragma mark Accessing a Source’s Content + +/** + A URL to a TileJSON configuration file describing the source’s contents and + other metadata. + + The URL may be a full HTTP or HTTPS URL or a Mapbox URL indicating the tile + set’s map ID (`mapbox://<mapid>`). + + If the receiver was initialized using `-initWithIdentifier:tileSet:`, this + property is set to `nil`. + */ +@property (nonatomic, readonly, copy) NSURL *URL; + +/** + A tile set describing the source’s contents and other metadata. + + If the receiver was initialized using `-initWithIdentifier:URL:`, this property + is set to `nil`. + */ +@property (nonatomic, readonly, nullable) MGLTileSet *tileSet; @end |