MCUtils

Namespace: dialog

dialog

Source:
dialog/dialog.js

Members

<constant> dialog

A ol-ext dialog to show information on the map See ol/control/Dialog

Source:
dialog/dialog.js

<constant> waitDialog

A wait dialog

Source:
dialog/waitDialog.js

Methods

dialog.show(options)

Extend ol-ext show method with markdown content. See ol-ext documentaion for more information: ol/control/Dialog~show

Parameters:
Name Type Description
options Object
Properties
Name Type Description
md string

the dialog content as a markdown
Source:
dialog/dialog.js

dialog.show404(msg, error)

Display a 404 page

Parameters:
Name Type Description
msg string

message
error string

information
Source:
dialog/dialog.js

dialog.showAlert(msg [, buttons] [, onButton])

Display an alert dialog

Parameters:
Name Type Argument Description
msg string
buttons * <optional>

a list of buttons to show on the dialog, default only one ok button
onButton function <optional>

a fucntion that takes the button id, when click on a button
Source:
dialog/dialog.js

dialog.showMessage(msg [, buttons] [, onButton])

Display an message dialog

Parameters:
Name Type Argument Description
msg string
buttons * <optional>

a list of buttons to show on the dialog, default only one ok button
onButton function <optional>

a fucntion that takes the button id, when click on a button
Source:
dialog/dialog.js

dialog.showWait(msg)

Display a wait dialog

Parameters:
Name Type Description
msg string
Source:
dialog/dialog.js

dialogImportFile(onImport, options)

A ol-ext dialog to import a file

Parameters:
Name Type Description
onImport function

a function that takes the imported features or a carte and the name of the file
options Object
Properties
Name Type Argument Default Description
title string <optional>

dialog title
className string <optional>
format string <optional>

format info
accept string <optional>

accepted formats
readCarte boolean <optional>
 false

can read carte
ignStyle boolean <optional>
 true

read features with ignStyle
useLayer boolean <optional>
 false

checkbox to use layer
projection Projection <optional>
 EPSG:3857

result projection
Source:
dialog/dialogImportFile.js

legendConfigurator(symbolLib, legend, options [, title] [, className] [, layers])

Legend configuration dialog See ol/control/Dialog

Parameters:
Name Type Argument Default Description
symbolLib Collection.<SymbolLib>
legend Legend
options Object
title string <optional>
 'Légende'
className string <optional>
layers Collection.<layer> <optional>
Source:
dialog/legendConfigurator.js

Namespace: dialog

dialog

Source:
dialog/waitDialog.js

Members

<constant> dialog

A ol-ext dialog to show information on the map See ol/control/Dialog

Source:
dialog/dialog.js

<constant> waitDialog

A wait dialog

Source:
dialog/waitDialog.js

Methods

dialog.show(options)

Extend ol-ext show method with markdown content. See ol-ext documentaion for more information: ol/control/Dialog~show

Parameters:
Name Type Description
options Object
Properties
Name Type Description
md string

the dialog content as a markdown
Source:
dialog/dialog.js

dialog.show404(msg, error)

Display a 404 page

Parameters:
Name Type Description
msg string

message
error string

information
Source:
dialog/dialog.js

dialog.showAlert(msg [, buttons] [, onButton])

Display an alert dialog

Parameters:
Name Type Argument Description
msg string
buttons * <optional>

a list of buttons to show on the dialog, default only one ok button
onButton function <optional>

a fucntion that takes the button id, when click on a button
Source:
dialog/dialog.js

dialog.showMessage(msg [, buttons] [, onButton])

Display an message dialog

Parameters:
Name Type Argument Description
msg string
buttons * <optional>

a list of buttons to show on the dialog, default only one ok button
onButton function <optional>

a fucntion that takes the button id, when click on a button
Source:
dialog/dialog.js

dialog.showWait(msg)

Display a wait dialog

Parameters:
Name Type Description
msg string
Source:
dialog/dialog.js

dialogImportFile(onImport, options)

A ol-ext dialog to import a file

Parameters:
Name Type Description
onImport function

a function that takes the imported features or a carte and the name of the file
options Object
Properties
Name Type Argument Default Description
title string <optional>

dialog title
className string <optional>
format string <optional>

format info
accept string <optional>

accepted formats
readCarte boolean <optional>
 false

can read carte
ignStyle boolean <optional>
 true

read features with ignStyle
useLayer boolean <optional>
 false

checkbox to use layer
projection Projection <optional>
 EPSG:3857

result projection
Source:
dialog/dialogImportFile.js

legendConfigurator(symbolLib, legend, options [, title] [, className] [, layers])

Legend configuration dialog See ol/control/Dialog

Parameters:
Name Type Argument Default Description
symbolLib Collection.<SymbolLib>
legend Legend
options Object
title string <optional>
 'Légende'
className string <optional>
layers Collection.<layer> <optional>
Source:
dialog/legendConfigurator.js