MCUtils

Namespace: JSONOptions

JSONOptions

JSON file definition

Source:
format/version/defV4.js

Type Definitions

CarteParam

Carte file definition (.carte)

Type:
  • Object
Properties:
Name Type Description
lon number

map position
lat number

map position
rot number

map rotation
zoom number

map zoom
title string

map title
description string

map description
Source:
format/version/defV4.js

ClusterOptions

Type:
  • Object
Properties:
Name Type Description
enabled boolean
maxZoom number
Source:
format/version/defV4.js

ControlParam

List of controls in the map

Type:
  • Object
Properties:
Name Type Argument Default Description
zoom boolean

display zoom buttons
scaleLine boolean

scale line
rotation boolean

enable map rotation
searchBar boolean

search tools
layerSwitcher boolean

add a layer switcher
locate boolean

add a locate button
printDlg boolean

add a print dialog button
mousePosition JSONOptions.MousePositionControl | boolean
legend JSONOptions.LegendControl | boolean <optional>
 false
Source:
format/version/defV4.js

LayerOption

Type:
  • Object
Properties:
Name Type Argument Default Description
id string
type string
title string
name string
description string
visibility boolean
opacity number
copyright string
cluster JSONOptions.ClusterOptions | boolean <optional>
 false

cluster options for type=Vector
popup|false JSONOptions.PopupOptions <optional>

cluster options for type=Vector
Source:
format/version/defV4.js

LayoutParam

Layout

Type:
  • Object
Properties:
Name Type Description
theme string
colors Array.<string>
voletPosition string

volet position left|right
voletWidth number

volet width
Source:
format/version/defV4.js

LegendControl

Legend control definition

Type:
  • Object
Properties:
Name Type Description
title string

Legend title
visible boolean

Is legend visible
width number

Legend width
lineHeight number

Legend line height
items Array.<Object>

An array of legend items
Source:
format/version/defV4.js

MousePositionControl

Mouse position control definition

Type:
  • Object
Properties:
Name Type Description
proj string

projection EPSG code
unit string

display unit dms (degre min sec) or dec (decimal)
Source:
format/version/defV4.js

Popup

Popup

Type:
  • Object
Properties:
Name Type Description
popup Object
tips Object
Source:
format/version/defV4.js

PopupContentOptions

Type:
  • Object
Properties:
Name Type Description
active boolean
title string
desc string
img string

image url
coord boolean

display coordinates
Source:
format/version/defV4.js

PopupOptions

Type:
  • Object
Properties:
Name Type Description
hover boolean
popupContent JSONOptions.PopupContentOptions
Source:
format/version/defV4.js

Step

Step

Type:
  • Object
Properties:
Name Type Description
title string
showTitle boolean
content string
center Array.<number>
zoom number
layers Array.<string>

list of displayed layers
layerIds Array.<string>

list of displayed layers id
Source:
format/version/defV4.js

StoryMapCarte

StoryMap JSON file format

Type:
  • Object
Properties:
Name Type Description
title string
id string
Source:
format/version/defV4.js

StoryMapParam

StoryMap parameters

Type:
  • Object
Properties:
Name Type Description
title string
subTitle string
logo string

logo url
showTitle boolean
description string
lon number
lat number
rot number
zoom number
Source:
format/version/defV4.js

SymbolItem

Type:
  • Object
Properties:
Name Type Description
name string
type string
style Object
Source:
format/version/defV4.js

TabOptions

TabOptions

Type:
  • Object
Properties:
Name Type Description
id string

id of the storymap
title string
showTitle boolean
description string
Source:
format/version/defV4.js