summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLOfflineRegion.h
blob: c668e3bf2246ee62f7a409cf4db658db2d327719 (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
35
36
37
#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

/**
 An object conforming to the `MGLOfflineRegion` protocol determines which
 resources are required by an `MGLOfflinePack` object.
 */
@protocol MGLOfflineRegion <NSObject>

/**
 URL of the style whose resources are required for offline viewing.
 
 In addition to the JSON stylesheet, different styles may require different font
 glyphs, sprite sheets, and other resources.
 
 The URL may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s
 map ID (`mapbox://styles/{user}/{style}`).
 */
@property (nonatomic, readonly) NSURL *styleURL;

/**
 Specifies whether to include ideographic glyphs in downloaded font data.
 Ideographic glyphs make up the majority of downloaded font data, but
 it is possible to configure the renderer to use locally installed fonts
 instead of relying on fonts downloaded as part of the offline pack.
 See `MGLIdeographicFontFamilyName` setting. Also, for regions outside of
 China, Japan, and Korea, these glyphs will rarely appear for non-CJK users.
 
 By default, this property is set to `NO`, so that the offline pack will
 include ideographic glyphs.
 */
@property (nonatomic) BOOL includesIdeographicGlyphs;

@end

NS_ASSUME_NONNULL_END