{"id":6069,"date":"2022-12-31T12:18:26","date_gmt":"2022-12-31T08:48:26","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6069"},"modified":"2023-01-19T14:32:03","modified_gmt":"2023-01-19T11:02:03","slug":"map-2","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/map-geobox-api-for-javascript\/map-2\/","title":{"rendered":"Maps"},"content":{"rendered":"

Methods:<\/h2>\n

createMap(options)<\/h3>\n

Creates a new map. This function is an asynchronous function.<\/p>\n

Parameters:<\/strong><\/p>\n

options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.name<\/div>\n
String<\/div>\n<\/td>\n
Name of new map.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of new map. This parameter is helpful in identifying maps easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of map.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to create a new map for a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n
\n
\n
options.extent<\/div>\n
Array?<\/div>\n<\/div>\n<\/td>\n
[[‘south west’][‘lng’], [‘south west’][‘lat’], [‘north east’][‘lng’],[‘north east’][‘lat’]]<\/td>\n<\/tr>\n
\n
\n
options.thumbnail<\/div>\n
String?<\/div>\n<\/div>\n<\/td>\n
Base64 image URL.<\/td>\n<\/tr>\n
\n
\n
options.style<\/div>\n
Object?<\/div>\n<\/div>\n<\/td>\n
{ version: <“version number here”>, sources: {}, layers: []}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Returns:<\/strong><\/p>\n

Map<\/a>:\u00a0Returns itself to allow for method chaining.<\/p>\n

Example:<\/strong><\/p>\n

const newMap = await Server.createMap({\r\n   'name': 'string',\r\n   'display_name' : 'string',\r\n   'user_id' : 0,\r\n   'extent': [51, 35, 52,36],\r\n   'thumbnail': 'string',\r\n   'style': {version: 0, sources: {}, layers: []}\r\n});<\/pre>\n
updateMap(map_uuid, options)<\/h3>\n
Updates the existing map. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
map_uuid is the available map uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.name<\/div>\n
String?<\/div>\n<\/td>\n
Name of map.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of map.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of map.<\/td>\n<\/tr>\n
\n
\n
options.extent<\/div>\n
Array?<\/div>\n<\/div>\n<\/td>\n
[[‘south west’][‘lng’], [‘south west’][‘lat’], [‘north east’][‘lng’],[‘north east’][‘lat’]]<\/td>\n<\/tr>\n
\n
\n
options.thumbnail<\/div>\n
String?<\/div>\n<\/div>\n<\/td>\n
Base64 image URL.<\/td>\n<\/tr>\n
\n
\n
options.style<\/div>\n
Object?<\/div>\n<\/div>\n<\/td>\n
{ version: <“version number here”>, sources: {}, layers: []}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Map<\/a>:\u00a0Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const map = await Server.updateMap('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'name': 'string',\r\n   'display_name' : 'string',\r\n   'extent': [51, 35, 52, 36],\r\n   'thumbnail': 'string',\r\n   'style': {version: 0, sources: {}, layers: []}\r\n});<\/pre>\n
deleteMap(map_uuid)<\/h3>\n
Deletes the existing map. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
map_uuid is the available map uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that show deleting was successful or not. Null message means deleting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await Server.deleteMap('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getMap(map_uuid)<\/h3>\n
Returns the desired existing map. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
map_uuid is the available map uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Map<\/a>: Returns map object to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const map = await Server.getMap('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getMaps(options)<\/h3>\n
Returns the desired existing maps. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.f<\/span><\/div>\n
String<\/div>\n
defult: ‘json’<\/div>\n<\/td>\n
Output format. Choices are: \u2018json\u2019 | \u2018html\u2019<\/td>\n<\/tr>\n
\n
options.q<\/span><\/div>\n
String?<\/div>\n<\/td>\n
Query filter based on OGC CQL standard<\/a>.
\ne.g. “field1 LIKE ‘%GIS%’ AND created_at > ‘2021-01-01′”<\/td>\n<\/tr>\n
\n
\n
options.search<\/span><\/div>\n
String?<\/div>\n<\/div>\n<\/td>\n
Search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value.
\nNOTE: if q param is defined this param will be ignored.<\/td>\n<\/tr>\n
\n
options.search_fields<\/div>\n
String?<\/div>\n<\/td>\n
Comma separated list of fields for searching<\/td>\n<\/tr>\n
\n
options.order_by<\/span><\/div>\n
String?<\/div>\n<\/td>\n
Comma separated list of fields for sorting results [field1 A|D, field2 A|D, \u2026]. e.g. name A, type D
\nNOTE: “A” denotes ascending order and “D” denotes descending order.<\/td>\n<\/tr>\n
\n
options.skip<\/span><\/div>\n
\n
Number?<\/div>\n
Default: 0<\/div>\n<\/div>\n<\/td>\n
Number of skipped maps.<\/td>\n<\/tr>\n
\n
\n
options.limit<\/span><\/div>\n
\n
Number?<\/div>\n
Default:10<\/div>\n<\/div>\n<\/div>\n<\/td>\n
Maximum number for result maps.<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch maps of a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n
\n
options.shared<\/span><\/div>\n
Bolean<\/div>\n
default: false<\/div>\n<\/td>\n
If true, returns only the maps that are shared.<\/td>\n<\/tr>\n
\n
options.page<\/span><\/div>\n
Number?<\/div>\n
Default:1<\/div>\n<\/td>\n
The minimum number of pages is 1.<\/td>\n<\/tr>\n
\n
options.page_size<\/span><\/div>\n
\n
Number?<\/div>\n
Default:10<\/div>\n<\/div>\n<\/td>\n
The minimum number of maps on each page is 1.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Map<\/a>: Returns map object to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const maps = await Server.getMaps({\r\n   order_by: \"created_at D\",\r\n   user_id: 0,\r\n   search: 'string',\r\n   shared:true,\r\n   limit: 10\r\n});<\/pre>\n
seedCacheMap(map_uuid, options)<\/h3>\n
Generates and stores tiles for the desired existing map. See generating and storing tiles<\/a> for more guidance.<\/p>\n
Parameters:<\/strong><\/p>\n
map_uuid is the available map uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.from_zoom<\/div>\n
Number<\/div>\n<\/td>\n
from_zoom parameter is between 0 and 22.<\/td>\n<\/tr>\n
\n
options.to_zoom<\/div>\n
Number<\/div>\n<\/td>\n
to_zoom parameter is between 0 and 22.<\/td>\n<\/tr>\n
\n
\n
options.extent<\/span><\/div>\n
Array<\/div>\n<\/div>\n<\/td>\n
[[‘south west’][‘lng’], [‘south west’][‘lat’], [‘north east’][‘lng’],[‘north east’][‘lat’]]<\/span><\/td>\n<\/tr>\n
\n
options.workers<\/div>\n
Number<\/div>\n<\/td>\n
Number of cpu cores.<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to build cache for a map of a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n
\n
options.scale<\/div>\n
\n
Number<\/div>\n
Default: null<\/div>\n<\/div>\n<\/td>\n
Choices are: 1, 2, or null (null here means both)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns task id to manage task.<\/p>\n
Example:<\/strong><\/p>\n
const taskId = await Server.seedCacheMap('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'from_zoom': 0,\r\n   'to_zoom': 2,\r\n   'extent': [51, 35, 52, 36],\r\n   'workers': 1,\r\n   'user_id': 2,\r\n   'scale': 2\r\n})<\/pre>\n
getCacheSizeMap(map_uuid)<\/h3>\n
Returns the size of tiles generated and stored for the desired map in bytes.<\/p>\n
Parameters:<\/strong><\/p>\n
map_uuid is the available map uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tiles size in byte.<\/p>\n
Example:<\/strong><\/p>\n
const tilesSize = await Server.getCacheSizeMap('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
clearCacheMap(map_uuid)<\/h3>\n
Removes generated tiles for the desired map.<\/p>\n
Parameters:<\/strong><\/p>\n
map_uuid is the available map uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows clearing was successful or not. Null message means clearing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await Server.clearCacheMap('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n","protected":false},"excerpt":{"rendered":"
Methods: createMap(options) Creates a new map. This function is an asynchronous function. Parameters: options (Object) Name Description options.name String Name of new map. options.display_name String? Display name of new map. This parameter is helpful in identifying maps easily. options.description String? Description of map. options.user_id Number? If the admin wants to create a new map for […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[65],"doc_tag":[],"class_list":["post-6069","docs","type-docs","status-publish","hentry","doc_category-map-geobox-api-for-javascript"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6069","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/comments?post=6069"}],"version-history":[{"count":51,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6069\/revisions"}],"predecessor-version":[{"id":6585,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6069\/revisions\/6585"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6069"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6069"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6069"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}