-
Notifications
You must be signed in to change notification settings - Fork 1
/
MPMapConfig.ts
211 lines (207 loc) · 5.4 KB
/
MPMapConfig.ts
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
import { MPFloorSelectorInterface, MapControl } from "../../index";
/**
* This configuration object is used when creating a new {@link MapControl} instance.
*
* @export
* @class MPMapConfig
* @typedef {MPMapConfig}
*/
export default class MPMapConfig {
/**
* Whether to use the default map styling used by MapsIndoors, true by default.
*
* @public
* @readonly
* @type {boolean}
*/
public readonly useDefaultMapsIndoorsStyle: boolean
/**
* The name of the typeface family to use on the map (the typeface must be supported on the native platform).
*
* @public
* @readonly
* @type {?string}
*/
public readonly typeface?: string;
/**
* The color of the label text (a Hex color String (#1f1f1f))
*
* @public
* @readonly
* @type {?string}
*/
public readonly color?: string;
/**
* Whether to show a white shadow behind the text to make it more readable.
*
* @public
* @readonly
* @type {?boolean}
*/
public readonly showHalo?: boolean;
/**
* Changes the text size of the maps marker labels.
*
* The size is in dense pixels (DP).
*
* @public
* @readonly
* @type {?number}
*/
public readonly textSize?: number;
/**
* Enable/Disable showing the floor selector.
*
* @public
* @readonly
* @type {?boolean}
*/
public readonly showFloorSelector?: boolean;
/**
* Enables/Disables the info window on user-selected locations.
*
* The info window is shown by default when the user selects a location (by tapping on it).
*
* @public
* @readonly
* @type {?boolean}
*/
public readonly showInfoWindowOnClick?: boolean;
/**
* Renders the positioning puck (blue dot) at the last known user position on the map.
*
* @public
* @readonly
* @type {?boolean}
*/
public readonly showUserPosition?: boolean;
/**
* Enable fade-in effect on MapsIndoors tiles.
* Changes will be reflected on the map upon changing floors.
*
* Default behavior is enabled fade-in.
*
* @public
* @readonly
* @type {?boolean}
*/
public readonly enableTileFadeIn?: boolean;
/**
* Replaces the default FloorSelector with a custom one.
*
* @public
* @readonly
* @type {?MPFloorSelectorInterface}
*/
public readonly floorSelector?: MPFloorSelectorInterface;
/**
* Creates an instance of MPMapConfig.
*
* @constructor
* @public
* @param {MPMapConfigParams} params
*/
public constructor(params: MPMapConfigParams) {
this.useDefaultMapsIndoorsStyle = params.useDefaultMapsIndoorsStyle;
this.typeface = params.mapLabelFont?.typeface;
this.color = params.mapLabelFont?.color;
this.showHalo = params.mapLabelFont?.showHalo;
this.textSize = params.textSize;
this.showFloorSelector = params.showFloorSelector;
this.showInfoWindowOnClick = params.showInfoWindowOnClick;
this.showUserPosition = params.showUserPosition;
this.enableTileFadeIn = params.enableTileFadeIn;
this.floorSelector = params.floorSelector;
}
}
/**
* Collection of label apperance settigns
*
* @export
* @interface MapLabelFont
* @typedef {MapLabelFont}
*/
export interface MapLabelFont {
/**
* The name of the typeface family to use on the map (the typeface must be supported on the native platform).
*
* @type {string}
*/
typeface: string,
/**
* The color of the label text (a Hex color String (#1f1f1f))
*
* @type {string}
*/
color: string,
/**
* Whether to show a white shadow behind the text to make it more readable.
*
* @type {boolean}
*/
showHalo: boolean,
}
/**
* Parameter interface for {@link MPMapConfig}.
*
* @export
* @interface MPMapConfigParams
* @typedef {MPMapConfigParams}
*/
export interface MPMapConfigParams {
/**
* Whether to use the default map styling used by MapsIndoors, true by default.
*
* @type {boolean}
*/
useDefaultMapsIndoorsStyle: boolean,
/**
* A map label configuration object.
*
* @type {?MapLabelFont}
*/
mapLabelFont?: MapLabelFont,
/**
* Changes the text size of the maps marker labels.
*
* The size is in dense pixels (DP).
*
* @type {?number}
*/
textSize?: number,
/**
* Enable/Disable showing the floor selector.
*
* @type {?boolean}
*/
showFloorSelector?: boolean,
/**
* Enables/Disables the info window on user-selected locations.
*
* The info window is shown by default when the user selects a location (by tapping on it).
*
* @type {?boolean}
*/
showInfoWindowOnClick?: boolean,
/**
* Renders the positioning puck (blue dot) at the last known user position on the map.
*
* @type {?boolean}
*/
showUserPosition?: boolean,
/**
* Enable fade-in effect on MapsIndoors tiles.
* Changes will be reflected on the map upon changing floors.
*
* Default behavior is enabled fade-in.
*
* @type {?boolean}
*/
enableTileFadeIn?: boolean,
/**
* Replaces the default FloorSelector with a custom one.
*
* @type {?MPFloorSelectorInterface}
*/
floorSelector?: MPFloorSelectorInterface,
}