{"id":6228,"date":"2023-01-04T13:05:19","date_gmt":"2023-01-04T09:35:19","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6228"},"modified":"2023-01-26T13:35:50","modified_gmt":"2023-01-26T10:05:50","slug":"working-with-tileset-2","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/tileset\/working-with-tileset-2\/","title":{"rendered":"Working with tileset"},"content":{"rendered":"

Tip: After you access the tileset<\/a> object, the following methods and properties are applicable on the tileset.<\/p>\n

Properties:<\/h2>\n

uuid<\/h3>\n

Returns the universally unique identifier\u00a0(UUID)<\/a> of the tileset.<\/p>\n

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

uuid<\/a>: Returns uuid string.<\/p>\n

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

const tilesetUuid = tileset.uuid;<\/pre>\n
name<\/h3>\n
Returns the name of the tileset.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns tileset name.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetName = tileset.name;<\/pre>\n
display_name<\/h3>\n
Returns the display name of the tileset.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns display name of tileset.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetDisplayName = tileset.display_name;<\/pre>\n
description<\/h3>\n
Returns the description of the tileset.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns tileset description.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetDescription = tileset.description;<\/pre>\n
created_at<\/h3>\n
Returns the time and date that the tileset was created.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns tileset created time.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetCreatedTime = tileset.created_at;<\/pre>\n
last_modified_at<\/h3>\n
Returns the time and date that the tileset attribute is updated.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns tileset updated time.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetModifiedTime = tileset.last_modified_at;<\/pre>\n
last_updated_at<\/h3>\n
Returns the time and date that the tileset content is updated.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns tileset updated time.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetUpdatedTime = tileset.last_updated_at;<\/pre>\n
is_shared<\/h3>\n
Indicates whether the tileset is shared or not.<\/p>\n
Returns:<\/strong><\/p>\n
Boolean: If true, tileset is shared.<\/p>\n
Example:<\/strong><\/p>\n
const isShared = tileset.is_shared;<\/pre>\n
id<\/h3>\n
Returns the tileset id.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tileset id.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetId = tileset.id;<\/pre>\n
owner_id<\/h3>\n
Returns the user ID that the tileset belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tileset owner id.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetOwnerId = tileset.owner_id;<\/pre>\n
state<\/h3>\n
Shows the status of the tileset construction.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns tileset state.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetState = tileset.state;<\/pre>\n
min_zoom<\/h3>\n
Returns the smallest zoom at which the tileset is displayed.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tileset minimum zoom number.<\/p>\n
Example:<\/strong><\/p>\n
const minZoom = tileset.min_zoom;<\/pre>\n
max_zoom<\/h3>\n
Returns the largest zoom at which the tileset is displayed.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tileset maximum zoom number.<\/p>\n
Example:<\/strong><\/p>\n
const maxZoom = tileset.max_zoom;<\/pre>\n
extent<\/h3>\n
Returns the coordinates of the tileset extent in the Web Mercator coordinate system.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array contains [southwest x, southwest y,\u00a0 northeast x, northeast y].<\/p>\n
Example:<\/strong><\/p>\n
const tilesetExtent = tileset.extent;<\/pre>\n
Methods:<\/h2>\n
getLayers()<\/h3>\n
Returns the layers that compose the tileset.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of layers that forming the tileset.<\/p>\n
Example:<\/strong><\/p>\n
const tilesetLayers = tileset.getLayers();<\/pre>\n
addLayer(layer_type, layer_uuid)<\/h3>\n
Adds vector layer or vector layer view to the tileset.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_type is ‘vector’ or ‘view’.<\/p>\n
layer_uuid is the available vector or view layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding layer was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = tileset.addLayer('vector','4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
removeLayer(layer_type, layer_uuid)<\/h3>\n
Removes vector layer or vector layer view from the tileset.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_type is ‘vector’ or ‘view’.<\/p>\n
layer_uuid is the available vector or view layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing layer was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = tileset.removeLayer('vector','4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n","protected":false},"excerpt":{"rendered":"
Tip: After you access the tileset object, the following methods and properties are applicable on the tileset. Properties: uuid Returns the universally unique identifier\u00a0(UUID) of the tileset. Returns: uuid: Returns uuid string. Example: const tilesetUuid = tileset.uuid; name Returns the name of the tileset. Returns: String: Returns tileset name. Example: const tilesetName = tileset.name; display_name […]<\/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-6228","docs","type-docs","status-publish","hentry","doc_category-tileset"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6228","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=6228"}],"version-history":[{"count":10,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6228\/revisions"}],"predecessor-version":[{"id":6664,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6228\/revisions\/6664"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6228"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6228"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6228"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}