{"id":6099,"date":"2022-12-31T15:45:31","date_gmt":"2022-12-31T12:15:31","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6099"},"modified":"2023-01-26T13:42:20","modified_gmt":"2023-01-26T10:12:20","slug":"working-with-vectorlayer","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/vector\/working-with-vectorlayer\/","title":{"rendered":"Vector layers"},"content":{"rendered":"

Methods:<\/h2>\n

createVectorLayer(options)<\/h3>\n

Creates a new vector layer. 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 vector layer.<\/td>\n<\/tr>\n
\n
options.layer_type<\/div>\n
String<\/div>\n<\/td>\n
Type of new vector layer. \u00a0Choices are: ‘Polygon’ | ‘Polyline’ | ‘Point’ | ‘MultiPoint’.<\/td>\n<\/tr>\n
\n
options.display_name<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Display name of new vector layer. This parameter is helpful in identifying vector layers easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of vector layer.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to create a new vector layer for a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n
\n
options.has_z<\/div>\n
bolean<\/div>\n
default: false<\/div>\n<\/td>\n
If true, geometry has z value.<\/td>\n<\/tr>\n
\n
\n
options.fields<\/div>\n
Array?<\/div>\n<\/div>\n<\/td>\n
\n
[{\r\n      'name': 'string',\r\n      'datatype': 'string', \/\/Choices are: 'String' | 'Integer' | 'Long' | 'Float' | 'Date' | 'Time' | 'DateTime'\r\n      'width': 'number',\r\n      'display_name': 'string'\r\n}]<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Vector layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const newVectorLayer = await Server.createVectorLayer({\r\n   'name': 'string',\r\n   'layer_type': 'Polygon',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'has_z': false,\r\n   'user_id' :0,\r\n   'fields': [\r\n      {\r\n         'name': 'string',\r\n         'datatype': 'String',\r\n         'width': 250,\r\n         'display_name': 'Parcel Name'\r\n      }\r\n   ]\r\n});<\/pre>\n
updateVectorLayer(layer_uuid, options)<\/h3>\n
Updates the existing vector layer. Geometry type is not editable. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_uuid is the available vector layer uuid.<\/p>\n
options (Object)<\/p>\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 vector layer.<\/td>\n<\/tr>\n
\n
options.display_name<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Display name of vector layer. This parameter is helpful in identifying vector layers easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of vector layer.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Vector layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayer = await Server.updateVectorLayer('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string'\r\n});<\/pre>\n
deleteVectorLayer(layer_uuid)<\/h3>\n
Deletes the existing vector layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_uuid is the available vector layer 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.deleteVectorLayer('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getVectorLayer(layer_uuid)<\/h3>\n
Returns the desired existing vector layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_uuid is the available vector layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Vector layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayer\u00a0= await Server.getVectorLayer('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getVectorLayersByIds(options)<\/h3>\n
Returns the desired existing vector layers. 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 vector layers. If you want a single vector layer, 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 vector layers 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 vector layers<\/a>.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayers = await Server.getVectorLayersByIds({\r\n   'ids': [25,125],\r\n   'user_id' :0\r\n});<\/pre>\n
getVectorLayerByName(name, user_id)<\/h3>\n
Returns the desired existing vector layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
name is the available vector layer name.<\/p>\n
user_id is the id of the user that the vector layer belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Vector layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayer = await Server.getVectorLayerByName('city',2);<\/pre>\n
getVectorLayers(options)<\/h3>\n
Returns the desired existing vector layers. 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\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.include_settings<\/div>\n
Bolean<\/div>\n
Default: false<\/div>\n<\/td>\n
If true, returns layer setting in layer_settings property.<\/td>\n<\/tr>\n
\n
options.f<\/span><\/div>\n
String<\/div>\n
Default: ‘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 vector layers.<\/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 vector layers.<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch vector layers 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 vector layers 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 vector layers on each page is 1.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of vector layers.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayers= await Server.getVectorLayers({q:`name = 'string'`,user_id :0});<\/pre>\n","protected":false},"excerpt":{"rendered":"
Methods: createVectorLayer(options) Creates a new vector layer. This function is an asynchronous function. Parameters: options (Object) Name Description options.name String Name of new vector layer. options.layer_type String Type of new vector layer. \u00a0Choices are: ‘Polygon’ | ‘Polyline’ | ‘Point’ | ‘MultiPoint’. options.display_name String? Display name of new vector layer. This parameter is helpful in identifying […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[66],"doc_tag":[],"class_list":["post-6099","docs","type-docs","status-publish","hentry","doc_category-vector"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6099","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=6099"}],"version-history":[{"count":43,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6099\/revisions"}],"predecessor-version":[{"id":6674,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6099\/revisions\/6674"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6099"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6099"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6099"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}