Namespace: serviceURL

Members

---

<static, constant> serviceURL

List of services url

Source:

api/serviceURL.js

Methods

---

<static> encodeTitleURL(title)

Encode a string as title to add in a url (only keep letters and digit)

Parameters:

Name	Type	Description
title	string

Source:

api/serviceURL.js

Returns:

encoded title

Type

string

---

<static> getDocumentationURL(category, article)

Get documentation (editorial) url

Parameters:

Name	Type	Description
category	string
article	string

Source:

api/serviceURL.js

Returns:

url

Type

string

---

<static> getEditorURL(carte)

Get viewer for a carte

Parameters:

Name	Type	Description
carte	Object	Properties Name Type Argument Default Description edit_id string title string <optional> 'carte' type string <optional> 'carte' map type 'storymap' or 'macarte' showTitle boolean <optional> true

Source:

api/serviceURL.js

Returns:

viewer url

Type

string

---

<static> getMediaURL(id)

Get media url

Parameters:

Name	Type	Description
id	string	media id

Source:

api/serviceURL.js

Returns:

media url

Type

string

---

<static> getTeamURL(team)

Get team url

Parameters:

Name	Type	Description
team	string | Object	team name

Source:

api/serviceURL.js

Returns:

user url

Type

string

---

<static> getUserURL(user)

Get user url

Parameters:

Name	Type	Description
user	string | Object	user name

Source:

api/serviceURL.js

Returns:

user url

Type

string

---

<static> getViewerURL(carte [, tab])

Get viewer for a carte

Parameters:

Name	Type	Argument	Description
carte	Object		Properties Name Type Argument Default Description view_id string title string <optional> 'carte' type string <optional> 'carte' map type 'storymap' or 'macarte' showTitle boolean <optional> true noZoom boolean <optional> false position Array.<number> <optional>
tab	boolean	<optional>	the map is inside a tab (onglet)

Source:

api/serviceURL.js

Returns:

viewer url

Type

string