57 lines
1.8 KiB
Objective-C
57 lines
1.8 KiB
Objective-C
#import <Foundation/Foundation.h>
|
||
|
||
#import "MGLFoundation.h"
|
||
#import "MGLTypes.h"
|
||
|
||
NS_ASSUME_NONNULL_BEGIN
|
||
|
||
FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLInvalidStyleSourceException;
|
||
|
||
/**
|
||
`MGLSource` is an abstract base class for map content sources. A map content
|
||
source supplies content to be shown on the map. A source is added to an
|
||
`MGLStyle` object along with an `MGLForegroundStyleLayer` object. The
|
||
foreground style layer defines the appearance of any content supplied by the
|
||
source.
|
||
|
||
Each source defined by the style JSON file is represented at runtime by an
|
||
`MGLSource` object that you can use to refine the map’s content. You can also
|
||
add and remove sources dynamically using methods such as
|
||
`-[MGLStyle addSource:]` and `-[MGLStyle sourceWithIdentifier:]`.
|
||
|
||
Create instances of `MGLShapeSource`, `MGLComputedShapeSource`,
|
||
`MGLImageSource`, and the concrete subclasses of `MGLTileSource`
|
||
(`MGLVectorTileSource` and `MGLRasterTileSource`) in order to use `MGLSource`’s
|
||
properties and methods. Do not create instances of `MGLSource` directly, and do
|
||
not create your own subclasses of this class.
|
||
*/
|
||
MGL_EXPORT
|
||
@interface MGLSource : NSObject
|
||
|
||
#pragma mark Initializing a Source
|
||
|
||
- (instancetype)init __attribute__((unavailable("Use -initWithIdentifier: instead.")));
|
||
|
||
/**
|
||
Returns a source initialized with an identifier.
|
||
|
||
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.
|
||
@return An initialized source.
|
||
*/
|
||
- (instancetype)initWithIdentifier:(NSString *)identifier;
|
||
|
||
#pragma mark Identifying a Source
|
||
|
||
/**
|
||
A string that uniquely identifies the source in the style to which it is added.
|
||
*/
|
||
@property (nonatomic, copy) NSString *identifier;
|
||
|
||
@end
|
||
|
||
NS_ASSUME_NONNULL_END
|