{"id":6148,"date":"2023-01-02T09:57:51","date_gmt":"2023-01-02T06:27:51","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6148"},"modified":"2023-01-26T13:47:58","modified_gmt":"2023-01-26T10:17:58","slug":"working-with-tileset","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/tileset\/working-with-tileset\/","title":{"rendered":"Tilesets"},"content":{"rendered":"

Methods:<\/h2>\n

createTileset(options)<\/h3>\n

Creates new tileset. 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 tileset.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of new tileset. This parameter is helpful in identifying tileset easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of tileset.<\/td>\n<\/tr>\n
\n
options.min_zoom<\/div>\n
Number?<\/div>\n<\/td>\n
Minimum zoom can be a number between 0 and 22.<\/td>\n<\/tr>\n
\n
options.max_zoom<\/div>\n
Number?<\/div>\n<\/td>\n
Maximum zoom can be a number between 0 and 22.<\/td>\n<\/tr>\n
\n
options.layers<\/div>\n
Array<\/div>\n<\/td>\n
Array of layers that you want to add to tileset. This array contains objects with layer_type and layer_uuid.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to create tileset for a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

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

Tileset<\/a>: Returns itself to allow for method chaining.<\/p>\n

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

const newTileset = await Server.createTileset({\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'min_zoom': 0,\r\n   'max_zoom': 22,\r\n   'layers': [\r\n      {'layer_type': 'vector',\r\n       'layer_uuid': '4f9f3e4b-4dc1-469b-83ab-00ae00f02581'\r\n      },\r\n      {'layer_type': 'view',\r\n       'layer_uuid': '4f9f3e4b-4dc1-469b-83ab-00ae00f02581'\r\n      }\r\n   ],\r\n   'user_id': 0\r\n});<\/pre>\n
updateTileset(tileset_uuid, options)<\/h3>\n
Updates the existing tileset. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
tileset_uuid is the available tileset uuid.<\/p>\n
options (Object)<\/p>\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 tileset.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of tileset. This parameter is helpful in identifying tileset easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of tileset.<\/td>\n<\/tr>\n
\n
options.min_zoom<\/div>\n
Number?<\/div>\n<\/td>\n
Minimum zoom can be a number between 0 and 22.<\/td>\n<\/tr>\n
\n
options.max_zoom<\/div>\n
Number?<\/div>\n<\/td>\n
Maximum zoom can be a number between 0 and 22.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Tileset<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const tileset = await Server.updateTileset({\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'min_zoom': 0,\r\n   'max_zoom': 22\r\n});<\/pre>\n
getTileset(tileset_uuid)<\/h3>\n
Returns the desired existing tileset. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
tileset_uuid is the available tileset uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Tileset<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const tileset = await Server.getTileset('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getTilesetsByIds(options)<\/h3>\n
Returns the desired existing tilesets. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.ids<\/div>\n
Number | Array<\/div>\n<\/td>\n
Ids of tilesets. If you want a single tileset, insert id as a string.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch tilesets of a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of tilesets.<\/p>\n
Example:<\/strong><\/p>\n
const tilesets = await Server.getTilesetsByIds({\r\n   'ids': [25,125],\r\n   'user_id' :0\r\n});<\/pre>\n
getTilesetByName(name, user_id)<\/h3>\n
Returns the desired existing tileset. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
name is the available tileset name.<\/p>\n
user_id is the id of the user that tileset belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Tileset<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const tileset = await Server.getTilesetByName('city',2);<\/pre>\n
getTilesets(options)<\/h3>\n
Returns the desired existing tilesets. 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 seperated 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 tilesets.<\/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 tilesets.<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch tilesets 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 tilesets 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
Array: Returns an array of tilesets.<\/p>\n
Example:<\/strong><\/p>\n
const tilesets = await Server.getTilesets({q:`name = 'string'`,user_id :0});<\/pre>\n
deleteTileset(tileset_uuid)<\/h3>\n
Deletes the desired existing tileset.<\/p>\n
Parameters:<\/strong><\/p>\n
tileset_uuid is the available tileset uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows deleting was successful or not. Null message means deleting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await Server.deleteTileset('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
seedCacheTileset(tileset_uuid, options)<\/h3>\n
Generates and stores tiles for the existing tileset. See generating and storing tiles<\/a>\u00a0for more guidance.<\/p>\n
Parameters:<\/strong><\/p>\n
tileset_uuid is the available tileset uuid.<\/p>\n
options (Object)<\/p>\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
[southwest x, southwest y,\u00a0 northeast x, northeast y]<\/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 tileset of a certain user, this parameter determines which user is the target user.<\/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.seedCacheTileset('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})<\/pre>\n
getCacheSizeTileset(tileset_uuid)<\/h3>\n
Returns the size of tiles generated and stored for tileset in bytes.<\/p>\n
Parameters:<\/strong><\/p>\n
tileset_uuid is the available tileset uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tiles size in byte.<\/p>\n
Example:<\/strong><\/p>\n
const tilesSize = await Server.getCacheSizeTileset('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
clearCacheTileset(tileset_uuid)<\/h3>\n
Removes generated tiles for the desired tileset.<\/p>\n
Parameters:<\/strong><\/p>\n
tileset_uuid is the available tileset 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.clearCacheTileset('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n","protected":false},"excerpt":{"rendered":"
Methods: createTileset(options) Creates new tileset. This function is an asynchronous function. Parameters: options (Object) Name Description options.name String Name of new tileset. options.display_name String? Display name of new tileset. This parameter is helpful in identifying tileset easily. options.description String? Description of tileset. options.min_zoom Number? Minimum zoom can be a number between 0 and 22. options.max_zoom […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[70],"doc_tag":[],"class_list":["post-6148","docs","type-docs","status-publish","hentry","doc_category-tileset"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6148","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=6148"}],"version-history":[{"count":16,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6148\/revisions"}],"predecessor-version":[{"id":6679,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6148\/revisions\/6679"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6148"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6148"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6148"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}