MCUtils

Class: Carte

mcutils.format. Carte

Base class for reading / writing .macarte

new Carte()

Constructor

Source:
format/Carte.js

Methods

read(carte, options)

Read method

Parameters:
Name Type Description
carte mcutils.Carte
options Object

json object
Source:
format/Carte.js
Returns:
Type
mcutils.Carte

readControls(carte, options)

Read controls for the current carte

Parameters:
Name Type Description
carte mcutils.Carte
options Object

json object
Source:
format/Carte.js

readLayer(options, key)

Read a single layer

Parameters:
Name Type Description
options Object

layer options (json object)
key string

GPP API key
Source:
format/Carte.js
Returns:
Type
ol/layer/Layer

readLayers(options, key)

Read layers

Parameters:
Name Type Description
options Object

json object
key string

GPP API key
Source:
format/Carte.js
Returns:
Type
Array.<ol/layer/Layer>

readView(view, options)

Read view param

Parameters:
Name Type Description
view View
options Object

json object
Source:
format/Carte.js

write(carte [, uncompressed])

Write method

Parameters:
Name Type Argument Default Description
carte mcutils.Carte
uncompressed boolean <optional>
 false
Source:
format/Carte.js
Returns:
Type
Object | boolean

writeLayer(layer)

Write a single layer

Parameters:
Name Type Description
layer ol/layer/Layer
Source:
format/Carte.js
Returns:

options layer options (json object)

Type
Object

writeLayers(layers [, uncompressed])

Write layers

Parameters:
Name Type Argument Default Description
layers Array.<ol/layer/Layer>
uncompressed boolean <optional>
 false
Source:
format/Carte.js
Returns:

options json object

Type
Object