MCUtils

Class: Legend

mcutils.format.control. Legend

MousePosition contorl reader/writer

new Legend(ctrl, options [, append] [, layers])

Constructor

Parameters:
Name Type Argument Default Description
ctrl ol.control.Legend

if defined, read the options
options Object
append boolean <optional>
 false
layers Array.<olLayer> <optional>
Source:
format/control/Legend.js

Extends

Methods

read(ctrl, options [, append] [, layers])

Read Legend

Parameters:
Name Type Argument Default Description
ctrl ol.control.Legend
options Object
append boolean <optional>
 false
layers Array.<olLayer> <optional>
Overrides:
Source:
format/control/Legend.js

read(Legend, options [, append] [, layers])

Read Legend

Parameters:
Name Type Argument Default Description
Legend ol_legend_Legend
options Object
append boolean <optional>
 false
layers Array.<olLayer> <optional>
Overrides:
Source:
format/Legend.js

write(ctrl)

Write Legend

Parameters:
Name Type Description
ctrl ol.control.Legend
Overrides:
Source:
format/control/Legend.js
Returns:
Type
Object

write(legend)

Write Legend

Parameters:
Name Type Description
legend ol_legend_Legend
Overrides:
Source:
format/Legend.js
Returns:
Type
Object

Class: Legend

mcutils.format.control. Legend

MousePosition contorl reader/writer

new Legend(legend, options [, append] [, layers])

Constructor

Parameters:
Name Type Argument Default Description
legend Legend

if defined, read the options
options Object
append boolean <optional>
 false
layers Array.<olLayer> <optional>
Source:
format/Legend.js

Extends

Methods

read(ctrl, options [, append] [, layers])

Read Legend

Parameters:
Name Type Argument Default Description
ctrl ol.control.Legend
options Object
append boolean <optional>
 false
layers Array.<olLayer> <optional>
Overrides:
Source:
format/control/Legend.js

read(Legend, options [, append] [, layers])

Read Legend

Parameters:
Name Type Argument Default Description
Legend ol_legend_Legend
options Object
append boolean <optional>
 false
layers Array.<olLayer> <optional>
Overrides:
Source:
format/Legend.js

write(ctrl)

Write Legend

Parameters:
Name Type Description
ctrl ol.control.Legend
Overrides:
Source:
format/control/Legend.js
Returns:
Type
Object

write(legend)

Write Legend

Parameters:
Name Type Description
legend ol_legend_Legend
Overrides:
Source:
format/Legend.js
Returns:
Type
Object