summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLSource.h
blob: ec3733bf0846c7aa32c6e08b33efd167e2d47ada (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
#import <Foundation/Foundation.h>

/**
 A source supplies data to be shown on the map. Sources don't contain styling 
 details like color or width. Use subclasses of `MGLStyleLayer` to give visual
 representation to sources.
 
 You should use the concrete subclasses of `MGLSource` to create vector, 
 raster, GeoJSON, and other source types.
 */
@interface MGLSource : NSObject

#pragma mark Initializing a Source

/**
 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