theme |
string
|
The theme of the map. Default is 'dark'. |
showLineUnits |
boolean
|
Show line units. Default is false. |
showFeatureText |
boolean
|
Show feature text. Default is true. |
controls |
object
|
boolean
|
Controls for the map. Default is false. True shows all controls.
Properties
| Name |
Type |
Description |
options |
boolean
|
Show options control. Default is false. |
modes |
boolean
|
Show modes control. Default is false. |
utils |
boolean
|
Show utilities control. Default is false. |
types |
boolean
|
Show types control. Default is false. |
actions |
boolean
|
Show actions control. Default is false. |
|
map |
object
|
Map options. Any Mapbox GL JS map options can be used here.
Properties
| Name |
Type |
Description |
container |
string
|
Map container. Default is 'map'. |
center |
array
|
Map center. Default is [-95.52816680236892, 39.56431143986035]. |
zoom |
number
|
Map zoom. Default is 3.5. |
maxPitch |
number
|
Maximum pitch of the map. Default is 50. |
projection |
string
|
Map projection. Default is 'mercator'. |
style |
string
|
Map style. Default is 'Standard'. |
opacity |
number
|
Map opacity. Default is 1. |
styles |
array
|
Mapbox styles with title and uri. |
extent |
array
|
Map bounding extent. |
|
keys |
object
|
Keyboard shortcuts.
Properties
| Name |
Type |
Description |
import |
string
|
Import key. Default is 'u'. |
export |
string
|
Export key. Default is 'd'. |
delete |
string
|
Delete key. Default is 'Delete'. |
cancel |
string
|
Cancel key. Default is 'Escape'. |
select |
string
|
Select key. Default is 'Escape'. |
edit |
string
|
Edit key. Default is 'Enter'. |
refresh |
string
|
Refresh key. Default is 'r'. |
snapping |
string
|
Snapping key. Default is '!'. |
pinning |
string
|
Pinning key. Default is '@'. |
routing |
string
|
Routing key. Default is '#'. |
exploring |
string
|
Exploring key. Default is '$'. |
painting |
string
|
Painting key. Default is '%'. |
polyline |
string
|
Polyline key. Default is '1'. |
polygon |
string
|
Polygon key. Default is '2'. |
rectangle |
string
|
Rectangle key. Default is '3'. |
circle |
string
|
Circle key. Default is '4'. |
text |
string
|
Text key. Default is '5'. |
|
units |
object
|
Measurement units for different geometries.
Properties
| Name |
Type |
Description |
Polyline |
string
|
Polyline unit. Default is 'feet'. |
Polygon |
string
|
Polygon unit. Default is 'acres'. |
Rectangle |
string
|
Rectangle unit. Default is 'acres'. |
Icon |
string
|
Icon unit. Default is 'feature'. |
Circle |
string
|
Circle unit. Default is 'feature'. |
Marker |
string
|
Marker unit. Default is 'feature'. |
|
colors |
object
|
Color scheme settings.
Properties
| Name |
Type |
Description |
error |
string
|
Error color. Default is '#ff7676'. |
primaryColor |
string
|
Primary color. Default is '#d7ef7e'. |
primaryBackground |
string
|
Primary background color. Default is '#5a5a5a'. |
primaryText |
string
|
Primary text color. Default is '#c5c5c5'. |
primaryBorder |
string
|
Primary border color. Default is '#6fafdb'. |
secondaryColor |
string
|
Secondary color. Default is '#6fafdb'. |
secondaryBackground |
string
|
Secondary background color. Default is '#333333'. |
secondaryText |
string
|
Secondary text color. Default is '#333333'. |
|
select |
object
|
Selection options.
Properties
| Name |
Type |
Description |
popup |
boolean
|
Enable selection popups. Default is false. |
multiple |
boolean
|
Allow multiple selection. Default is false. |
|
snapping |
object
|
Snapping settings.
Properties
| Name |
Type |
Description |
enable |
boolean
|
Enable snapping to features. Default is false. |
pixels |
boolean
|
Pixel-based snapping. Default is false. |
distance |
number
|
Snapping distance in kilometers. |
tolerance |
number
|
Snapping tolerance in kilometers. |
|
routing |
object
|
Routing settings.
Properties
| Name |
Type |
Description |
enable |
boolean
|
Enable routing functionality. Default is false. |
precision |
number
|
Routing coordinate precision. |
|
pinning |
object
|
Pinning settings.
Properties
| Name |
Type |
Description |
enable |
boolean
|
Enable feature pinning. Default is false. |
buffer |
number
|
Pinning buffer distance in kilometers. |
idle |
number
|
Idle time before updating pinned features. |
|
exploring |
object
|
Exploring settings.
Properties
| Name |
Type |
Description |
enable |
boolean
|
Enable feature exploration. Default is false. |
minZoom |
number
|
Minimum zoom level for exploration. Default is 9. |
buffer |
number
|
Exploration buffer distance in kilometers. |
tolerance |
number
|
Exploration coordinate simplification tolerance. |
|
painting |
object
|
Painting settings.
Properties
| Name |
Type |
Description |
enable |
boolean
|
Enable painting mode. Default is false. |
tolerance |
number
|
Painting coordinate simplification tolerance. |
|
gaming |
object
|
Gamepad configuration settings.
Properties
| Name |
Type |
Description |
enable |
boolean
|
Enable gaming support. Default is true. |
debug |
boolean
|
Enable gaming debugging. Default is false. |
crosshairs |
boolean
|
Show centerMarker on the map. Default is true. |
joystick |
object
|
Joystick settings.
Properties
| Name |
Type |
Description |
min |
number
|
Minimum joystick threshold. Default is 0.2. |
max |
number
|
Maximum joystick threshold. Default is 0.7. |
|
pan |
object
|
Pan settings.
Properties
| Name |
Type |
Description |
speed |
number
|
Pan speed. Default is 0.001. |
|
zoom |
object
|
Zoom settings.
Properties
| Name |
Type |
Description |
speed |
number
|
Zoom speed. Default is 0.008. |
|
|