{"id":6117,"date":"2023-01-01T10:59:45","date_gmt":"2023-01-01T07:29:45","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6117"},"modified":"2023-01-26T13:43:22","modified_gmt":"2023-01-26T10:13:22","slug":"working-with-vectorlayerview","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/view\/working-with-vectorlayerview\/","title":{"rendered":"Vector layer views"},"content":{"rendered":"

Methods:<\/h2>\n

createVectorLayerView(layer_uuid, options)<\/h3>\n

Creates a new vector layer view from the existing vector layer. This function is an asynchronous function.<\/p>\n

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

layer_uuid is the available vector layer uuid that you want to create vector layer view from.<\/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 view.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of new vector layer view. This parameter is helpful in identifying vector layer views easily.<\/td>\n<\/tr>\n
\n
options.description<\/div>\n
String?<\/div>\n<\/td>\n
Description of vector layer view.<\/td>\n<\/tr>\n
\n
options.view_filter<\/div>\n
String?<\/div>\n<\/td>\n
Query filter based on\u00a0OGC CQL standard<\/a>.
\ne.g. “field1 LIKE ‘%GIS%’ AND created_at > ‘2021-01-01′”<\/td>\n<\/tr>\n
\n
options.view_extent<\/span><\/div>\n
Array?<\/span><\/div>\n
Coordinates should be on the web mercator coordinate system.<\/span><\/div>\n<\/td>\n
[[‘south west’][‘x’], [‘south west’][‘y’], [‘north east’][‘x’],[‘north east’][‘y’]]<\/span><\/td>\n<\/tr>\n
\n
options.view_cols<\/div>\n
String | Array?<\/div>\n<\/td>\n
‘[ALL]’ | Comma separated list of fields name.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to create new vector layer view 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

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

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

const newVectorLayerView = await Server.createVectorLayerView('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'user_id' :0,\r\n   'view_filter': \"province_name = 'Tehran'\",\r\n   'view_extent': [\r\n      5667477,\r\n      4234242,\r\n      5762609,\r\n      4319221\r\n   ],\r\n  'view_cols': '[ALL]'\r\n});<\/pre>\n
updateVectorLayerView(layer_uuid, options)<\/h3>\n
Updates the existing vector layer view. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_uuid is the available vector layer view uuid.<\/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 vector layer view.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of vector layer view. This parameter is helpful in identifying vector layer views easily.<\/td>\n<\/tr>\n
\n
options.description<\/div>\n
String?<\/div>\n<\/td>\n
Description of vector layer view.<\/td>\n<\/tr>\n
\n
options.view_filter<\/div>\n
String?<\/div>\n<\/td>\n
Query filter based on\u00a0OGC CQL standard<\/a>.
\ne.g. “field1 LIKE ‘%GIS%’ AND created_at > ‘2021-01-01′”<\/td>\n<\/tr>\n
\n
options.view_extent<\/span><\/div>\n
Array?<\/span><\/div>\n
Coordinates should be on the web mercator coordinate system.<\/span><\/div>\n<\/td>\n
[[‘south west’][‘x’], [‘south west’][‘y’], [‘north east’][‘x’],[‘north east’][‘y’]]<\/span><\/td>\n<\/tr>\n
\n
options.view_cols<\/div>\n
String | Array?<\/div>\n<\/td>\n
‘[ALL]’ | Comma separated list of fields name.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to create new vector layer view 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
vector layer view<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerView = await Server.updateVectorLayerView('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'user_id' :0,\r\n   'view_filter': \"province_name = 'Tehran'\",\r\n   'view_extent': [\r\n      5667477,\r\n      4234242,\r\n      5762609,\r\n      4319221\r\n   ],\r\n  'view_cols': '[ALL]'\r\n});<\/pre>\n
deleteVectorLayerView(layer_uuid)<\/h3>\n
Deletes the existing vector layer view. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_uuid is the available vector layer view 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><\/code><\/p>\n
const result = await Server.deleteVectorLayerView('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getVectorLayerView(layer_uuid)<\/h3>\n
Returns the desired existing vector layer view. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
layer_uuid is the available vector layer view uuid.<\/p>\n
Returns:<\/strong><\/p>\n
vector layer view<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayer = await Server.getVectorLayerView('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getVectorLayerViewsByIds(options)<\/h3>\n
Returns the desired existing vector layer views. 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 layer view. If you want a single vector layer view, 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 layer views 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 layer views<\/a>.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerViews = await Server.getVectorLayerViewsByIds({\r\n   'ids': [25,125],\r\n   'user_id' :0\r\n});<\/pre>\n
getVectorLayerViewByName(name, user_id)<\/h3>\n
Returns the desired existing vector layer view. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
name is the available vector layer view name.<\/p>\n
user_id is the id of the user that vector layer view belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
vector layer view<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerView = await Server.getVectorLayerViewByName('city',2);<\/pre>\n
getVectorLayerViews(options)<\/h3>\n
Returns the desired existing vector layer views. 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
defult: 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
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 vector layer views.<\/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 layer views..<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch vector layer views 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 layer views 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 layer views on each page is 1.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of vector layer views<\/a>.<\/p>\n
Example:<\/strong><\/code><\/p>\n
const vectorLayerViews = await Server.getVectorLayerViews({q:`name = 'string'`,user_id :0});<\/pre>\n","protected":false},"excerpt":{"rendered":"
Methods: createVectorLayerView(layer_uuid, options) Creates a new vector layer view from the existing vector layer. This function is an asynchronous function. Parameters: layer_uuid is the available vector layer uuid that you want to create vector layer view from. options (Object) Name Description options.name String Name of new vector layer view. options.display_name String? Display name of new […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[67],"doc_tag":[],"class_list":["post-6117","docs","type-docs","status-publish","hentry","doc_category-view"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6117","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=6117"}],"version-history":[{"count":27,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6117\/revisions"}],"predecessor-version":[{"id":6676,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6117\/revisions\/6676"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6117"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6117"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6117"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}