{"id":6185,"date":"2023-01-03T10:36:47","date_gmt":"2023-01-03T07:06:47","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6185"},"modified":"2023-01-26T13:36:32","modified_gmt":"2023-01-26T10:06:32","slug":"working-with-vector","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/vector\/working-with-vector\/","title":{"rendered":"Vector layer object"},"content":{"rendered":"

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

Properties:<\/h2>\n

uuid<\/h3>\n

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

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

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

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

const vectorLayerUuid = vectorLayer.uuid;<\/pre>\n
name<\/h3>\n
Returns the name of the vector layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns vector layer name.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerName = vectorLayer.name;<\/pre>\n
display_name<\/h3>\n
Returns the display name of the vector layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns vector layer display name.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerDisplayName = vectorLayer.display_name;<\/pre>\n
description<\/h3>\n
Returns the description of the vector layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns vector layer description.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerDescription = vectorLayer.description;<\/pre>\n
created_at<\/h3>\n
Returns the time and date that the vector layer was created.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns vector layer created time.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerCreatedTime = vectorLayer.created_at;<\/pre>\n
last_edit_at<\/h3>\n
Returns the time and date that the vector layer is updated.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns vector layer updated time.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerModifiedTime = vectorLayer.last_edit_at;<\/pre>\n
is_shared<\/h3>\n
Indicates whether the vector layer is shared or not.<\/p>\n
Returns:<\/strong><\/p>\n
Boolean: If true, vector layer is shared.<\/p>\n
Example:<\/strong><\/p>\n
const isShared = vectorLayer.is_shared;<\/pre>\n
is_view<\/h3>\n
Indicates whether the vector layer is vector layer view or not.<\/p>\n
Returns:<\/strong><\/p>\n
Boolean: If true, vector layer is vector layer view.<\/p>\n
Example:<\/strong><\/p>\n
const isView = vectorLayer.is_view;<\/pre>\n
has_z<\/h3>\n
Indicates whether the vector layer geometry is 3D or not.<\/p>\n
Returns:<\/strong><\/p>\n
Boolean: If true, vector layer geometry is 3D and has z value.<\/p>\n
Example:<\/strong><\/p>\n
const hasZ = vectorLayer.has_z;<\/pre>\n
id<\/h3>\n
Returns the vector layer id.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns vector layer id.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerId = vectorLayer.id;<\/pre>\n
owner_id<\/h3>\n
Returns the user ID that the vector layer belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns vector layer owner id.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerOwnerId = vectorLayer.owner_id;<\/pre>\n
layer_type<\/h3>\n
Returns the type of geometry of the vector layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns geometry type of vector layer.<\/p>\n
Example:<\/strong><\/p>\n
const vectorLayerType = vectorLayer.layer_type;<\/pre>\n
layer_settings<\/h3>\n
Returns the vector layer settings. This parameter has a value if include_settings is true at the time of getting vector layer<\/a>.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns settings object.<\/p>\n
Example:<\/strong><\/p>\n
const layerSettings = vectorLayer.layer_settings;<\/pre>\n
extent<\/h3>\n
Returns the coordinates of the vector layer 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 vectorLayerExtent = vectorLayer.extent;<\/pre>\n
feature_count<\/h3>\n
Returns the number of features in the vector layer.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns count of features.<\/p>\n
Example:<\/strong><\/p>\n
const featureCount = vectorLayer.feature_count;<\/pre>\n
Methods:<\/h2>\n
addField(options)<\/h3>\n
Adds new field to the vector layer.<\/p>\n
Parameters:<\/strong><\/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 new field.<\/td>\n<\/tr>\n
options.display_name<\/p>\n
String?<\/div>\n<\/td>\n
Display name of new field.<\/td>\n<\/tr>\n
options.description<\/p>\n
String?<\/div>\n<\/td>\n
Description of field.<\/td>\n<\/tr>\n
\n
options.datatype<\/div>\n
String<\/div>\n<\/td>\n
Choices are: ‘String’ | ‘Integer’ | ‘Long’ | ‘Float’ | ‘Date’ | ‘Time’ | ‘DateTime’<\/td>\n<\/tr>\n
\n
options.width<\/div>\n
Number<\/div>\n<\/td>\n
Field length<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns field object.<\/p>\n
Example:<\/strong><\/p>\n
const newField = await vectorLayer.addField({\r\n  'name': 'string',\r\n  'display_name': 'string',\r\n  'description': 'string',\r\n  'datatype': 'String',\r\n  'width': 10\r\n})<\/pre>\n
updateField(field_id, options)<\/h3>\n
Updates the existing field of vector layer.<\/p>\n
Parameters:<\/strong><\/p>\n
field_id is the id of an available field.<\/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 field.<\/td>\n<\/tr>\n
\n
options.display_name<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Display name of field.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of field.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns field object.<\/p>\n
Example:<\/strong><\/p>\n
const field = await vectorLayer.updateField(10,{\r\n  'name': 'string',\r\n  'display_name': 'string',\r\n  'description': 'string'\r\n})<\/pre>\n
getFields()<\/h3>\n
Returns the vector layer fields.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of fields.<\/p>\n
Example:<\/strong><\/p>\n
const allFields = await vectorLayer.getFields();<\/pre>\n
getFieldStats(field_id, options)<\/h3>\n
Returns the statistical parameters of the field, including the minimum value, the maximum value, and the average.<\/p>\n
Parameters:<\/strong><\/p>\n
field_id is the id of an available field.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.func_type<\/div>\n
String<\/div>\n<\/td>\n
\u00a0choices are ‘min’ | ‘max’ | ‘avg’.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
String: Returns field statistic value.<\/p>\n
Example:<\/strong><\/p>\n
const fieldStat = await vectorLayer.getFieldStats(10,{func_type:'avg'});<\/pre>\n
getFieldUniqueValues(field_id, options)<\/h3>\n
Returns the unique values of the field.<\/p>\n
Parameters:<\/strong><\/p>\n
field_id is the id of an available field.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.exclude_null<\/div>\n
Boolean<\/div>\n
defult: false<\/div>\n<\/td>\n
If true, null values skipped.<\/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 unique values.<\/td>\n<\/tr>\n
\n
\n
options.limit<\/span><\/div>\n
\n
Number?<\/div>\n
Default:50<\/div>\n<\/div>\n<\/div>\n<\/td>\n
Maximum number for result unique values..<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of unique values.<\/p>\n
Example:<\/strong><\/p>\n
const fieldUniqueValues = await vectorLayer.getFieldUniqueValues(10);<\/pre>\n
getFieldUniqueValuesCount(field_id, options)<\/h3>\n
Returns the number of unique values of the field.<\/p>\n
Parameters:<\/strong><\/p>\n
field_id is the id of an available field.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.exclude_null<\/div>\n
Boolean<\/div>\n
defult: false<\/div>\n<\/td>\n
If true, null values skipped.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Number: Returns count of unique values.<\/p>\n
Example:<\/strong><\/p>\n
const fieldUniqueValuesCount = await vectorLayer.getFieldUniqueValuesCount(10);<\/pre>\n
deleteField(field_id)<\/h3>\n
Deletes the existing field.<\/p>\n
Parameters:<\/strong><\/p>\n
field_id is the id of an available field.<\/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 vectorLayer.deleteField(2);<\/pre>\n
deleteFields(field_ids)<\/h3>\n
Deletes the existing fields.<\/p>\n
Parameters:<\/strong><\/p>\n
field_ids is an array of ids of available fields.<\/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 vectorLayer.deleteFields([2,125]);<\/pre>\n
getSettings()<\/h3>\n
Returns the vector layer settings.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns settings object.<\/p>\n
Example:<\/strong><\/p>\n
const layerSettings = await vectorLayer.getSettings();<\/pre>\n
updateSettings(options)<\/h3>\n
Updates the vector layer settings.<\/p>\n
Parameters:<\/strong><\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.general_settings<\/div>\n
String<\/div>\n<\/td>\n
e.g. { ‘title_field’: ‘name’}<\/td>\n<\/tr>\n
\n
options.edit_settings<\/code><\/div>\n
String?<\/div>\n<\/td>\n
e.g. { ‘editable’: true, ‘edit_geometry’: true, ‘editable_attributes’: ‘[ALL]’, ‘allow_insert’: true, ‘allow_delete’: true }<\/td>\n<\/tr>\n
\n
options.tile_settings<\/code><\/div>\n
String?<\/div>\n<\/td>\n
e.g. { ‘min_zoom’: 0, ‘max_zoom’: 22, ‘max_features’: 65536, ‘filter_features’: true, ‘fields’: [ ‘id’ ], ‘use_cache’: true, ‘cache_until_zoom’: 17 }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns settings object.<\/p>\n
Example:<\/strong><\/p>\n
const layerSettings = await vectorLayer.updateSettings({\r\n   'general_settings': {\r\n      'title_field': 'name'\r\n   },\r\n   'edit_settings': {\r\n      'editable': true,\r\n      'edit_geometry': true,\r\n      'editable_attributes': '[ALL]',\r\n      'allow_insert': true,\r\n      'allow_delete': true\r\n   },\r\n   'tile_settings': {\r\n      'min_zoom': 0,\r\n      'max_zoom': 22,\r\n      'max_features': 65536,\r\n      'filter_features': true,\r\n      'fields': [\r\n         'id'\r\n      ],\r\n      'use_cache': true,\r\n      'cache_until_zoom': 17\r\n   }\r\n});<\/pre>\n
getTilejson()<\/h3>\n
Returns vector layer tile information such as tile access address.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains vector layer tiles information.<\/p>\n
Example:<\/strong><\/p>\n
const layerTilejson = await vectorLayer.getTilejson();<\/pre>\n
getFeature(feature_id)<\/h3>\n
Returns the GeoJSON of the desired feature of the vector layer.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_id is the id of an available feature.<\/p>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns geojson of feature.<\/p>\n
Example:<\/strong><\/p>\n
const feature = await vectorLayer.getFeature(1);<\/pre>\n
getFeatures(option)<\/h3>\n
Returns the GeoJSON of the desired features of the vector layer.<\/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\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.f<\/div>\n
String?<\/div>\n
Default: ‘json’<\/div>\n<\/td>\n
Output format. Choices are: ‘json’ | ‘topojson’ | ‘html’<\/td>\n<\/tr>\n
\n
options.quant_factor<\/div>\n
Number?<\/div>\n
Default: 1000000<\/div>\n<\/td>\n
Quantization factor. This parameter is only used by topojson encoder and is ignored for other formats. Higher quantizaion value means higher geometry precision.<\/td>\n<\/tr>\n
\n
options.skip<\/div>\n
Number?<\/div>\n
Default: 0<\/div>\n<\/td>\n
Number of skipped features.<\/td>\n<\/tr>\n
\n
options.limit<\/div>\n
Number?<\/div>\n
Default:100<\/div>\n<\/td>\n
Maximum number for result features.<\/td>\n<\/tr>\n
\n
options.search<\/div>\n
String<\/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.skip_geometry<\/div>\n
Boolean?<\/div>\n
Default: false<\/div>\n<\/td>\n
If true, output result does not have geometry.<\/td>\n<\/tr>\n
\n
options.return_count<\/div>\n
\n
Boolean?<\/div>\n
Default: false<\/div>\n<\/div>\n<\/td>\n
if true, returns only the number of features that satisfy conditions.<\/td>\n<\/tr>\n
\n
options.feature_ids<\/div>\n
String?<\/div>\n<\/td>\n
Comma separated list of feature ids which should be filtered.<\/td>\n<\/tr>\n
\n
options.select_fields<\/div>\n
String?<\/div>\n
Default: [ALL]<\/div>\n<\/td>\n
\n
\n
Comma separated field names which should be included to the result.<\/p>\n<\/div>\n<\/td>\n<\/tr>\n
\n
options.skip_fields<\/div>\n
String?<\/div>\n<\/td>\n
Comma separated field names which should be excluded from the result.<\/td>\n<\/tr>\n
options.out_srid<\/p>\n
String?<\/div>\n
Default: 3857<\/div>\n<\/td>\n
Srid (epsg code) of result features. e.g. 4326<\/td>\n<\/tr>\n
\n
options.order_by<\/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, length D
\nNOTE: “A” denotes ascending order and “D” denotes descending order.<\/td>\n<\/tr>\n
options.q<\/p>\n
String<\/div>\n<\/td>\n
Query filter based on OGC CQL standard<\/a>.
\ne.g. Name LIKE ‘%GIS%’ AND INTERSECTS(geometry, ‘SRID=3857;POLYGON((4901948 2885079, 7049893 2885079, 7049893 4833901, 4901948 4833901, 4901948 2885079))’)<\/td>\n<\/tr>\n
\n
options.bbox<\/div>\n
Array?<\/div>\n<\/td>\n
e.g. [50.275, 35.1195, 51.4459, 36.0416]<\/td>\n<\/tr>\n
\n
options.bbox_srid<\/div>\n
Number?<\/div>\n
Default: 3857<\/div>\n<\/td>\n
Srid (epsg code) of bbox. e.g. 4326.<\/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 features on each page is 1.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns geojson of features.<\/p>\n
Example:<\/strong><\/p>\n
const features = await vectorLayer.getFeatures({\r\n   f: \"json\",\r\n   q: `id=1`,\r\n   out_srid: 4326,\r\n   select_fields: [\"id\"]\r\n})<\/pre>\n
createFeature(geojson)<\/h3>\n
Creates new feature.<\/p>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns created feature geojson.<\/p>\n
Example:<\/strong><\/p>\n
const newFeature = await vectorLayer.createFeature({\r\n   'type': 'Feature',\r\n   'geometry': {\r\n      'type': 'Point',\r\n      'coordinates': [5610214, 4215675],\r\n   },\r\n   'properties': {'name':'tehran'}\r\n})<\/pre>\n
deleteFeature(feature_id)<\/h3>\n
Deletes the desired feature from the vector layer.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_id is the id of an available feature.<\/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 vectorLayer.deleteFeature(10);<\/pre>\n
deleteFeatures(feature_ids)<\/h3>\n
Deletes the desired features of the vector layer.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_ids is a comma separated list of ids of features.<\/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 vectorLayer.deleteFeatures([10,20]);<\/pre>\n
updateFeature(feature_id, geojson)<\/h3>\n
Updates the desired feature of the vector layer.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_id is the id of an available feature.<\/p>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns feature geojson.<\/p>\n
Example:<\/strong><\/p>\n
const feature = await vectorLayer.updateFeature(10,{\r\n   'type': 'Feature',\r\n   'geometry': {\r\n      'type': 'Point',\r\n      'coordinates': [5610214, 4215675],\r\n   },\r\n   'properties' = {'name':'tehran'}\r\n})<\/pre>\n
updateFeatureGeometry(feature_id, options)<\/h3>\n
Updates the desired feature geometry.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_id is the id of an available feature.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.type<\/div>\n
String<\/div>\n<\/td>\n
Type of geometry.<\/td>\n<\/tr>\n
\n
options.coordinates<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Array of coordinates.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns feature geojson.<\/p>\n
Example:<\/strong><\/p>\n
const feature = await vectorLayer.updateFeatureGeometry(10,{\r\n   'type': 'Point',\r\n   'coordinates': [5610214, 4215675],\r\n})<\/pre>\n
updateFeatureProps(feature_id, options)<\/h3>\n
Updates the desired feature attributes.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_id is the id of an available feature.<\/p>\n
options (Object): Object of fields and values.<\/p>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns feature geojson.<\/p>\n
Example:<\/strong><\/p>\n
const feature = await vectorLayer.updateFeatureProps(10,{\r\n   'name': 'tehran'\r\n})<\/pre>\n
updateFeaturePropsAndGeometry(feature_id, properties_options, geometry_options)<\/h3>\n
Updates the desired feature geometry and attributes.<\/p>\n
Parameters:<\/strong><\/p>\n
feature_id is the id of an available feature.<\/p>\n
properties_options (Object): Object of fields and values.<\/p>\n
geometry_options (Object)<\/p>\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.type<\/div>\n
String<\/div>\n<\/td>\n
Type of geometry.<\/td>\n<\/tr>\n
\n
options.coordinates<\/code><\/div>\n
String<\/div>\n<\/td>\n
Array of coordinates.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Geojson<\/a>: Returns feature geojson.<\/p>\n
Example:<\/strong><\/p>\n
const feature = await vectorLayer.updateFeaturePropsAndGeometry(10,\r\n   {'name': 'tehran'},\r\n   {'type': 'Point', 'coordinates': [5610214, 4215675]}\r\n)<\/pre>\n
seedCache(options)<\/h3>\n
Generates and stores tiles for the existing vector layer. See generating and managing vector layers<\/a> for more guidance.<\/p>\n
Parameters:<\/strong><\/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
options.ignore_cache<\/div>\n
Boolean<\/div>\n
default: true<\/div>\n<\/td>\n
If true, ignore previous cache.<\/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 builds cache for a vector layer 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 vectorLayer.seedCache({\r\n   'from_zoom': 0,\r\n   'to_zoom': 2,\r\n   'ignore_cache': true,\r\n   'workers': 1,\r\n   'user_id': 2\r\n})<\/pre>\n
getCacheSize()<\/h3>\n
Returns the size of tiles generated and stored for vector layer in bytes.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tiles size in byte.<\/p>\n
Example:<\/strong><\/p>\n
const tilesSize = await vectorLayer.getCacheSize();<\/pre>\n
clearCache()<\/h3>\n
Removes generated tiles for the desired vector layer.<\/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 vectorLayer.clearCache();<\/pre>\n
importFile(options)<\/h3>\n
Imports file data to the vector layer.<\/p>\n
Parameters:<\/strong><\/p>\n
options (FormData<\/a>)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
\n
file_uuid<\/div>\n<\/div>\n
String<\/div>\n<\/td>\n
Universally unique identifier (UUID)<\/a> of the file that is published in the geobox portal.<\/td>\n<\/tr>\n
\n
file_encoding<\/div>\n
String<\/div>\n
Deafult: ‘utf-8’<\/div>\n<\/td>\n
Encoding of the file. e.g.\u00a0‘utf-8’<\/td>\n<\/tr>\n
\n
input_srid<\/div>\n
\n
Number<\/div>\n
Deafult: 3857<\/div>\n<\/div>\n<\/td>\n
srid of the input layer<\/td>\n<\/tr>\n
\n
input_layer<\/div>\n
String<\/div>\n<\/td>\n
Name of the layer that you want to import.<\/td>\n<\/tr>\n
\n
input_dataset<\/div>\n
String<\/div>\n<\/td>\n
Name of the dataset that you want to import layer from.<\/td>\n<\/tr>\n
\n
input_geom_type<\/div>\n
\n
String<\/div>\n<\/div>\n<\/td>\n
If there are multiple geometry type in the dataset, select the geometry type that you want to import. Choices are: ‘POINT’| ‘LINESTRING’| ‘POLYGON’| ‘MULTIPOINT’| ‘MULTILINESTRING’| ‘MULTIPOLYGON’| ‘POINTZ’| ‘LINESTRINGZ’| ‘POLYGONZ’| ‘MULTIPOINTZ’| ‘MULTILINESTRINGZ’| ‘MULTIPOLYGONZ’.<\/td>\n<\/tr>\n
\n
report_errors<\/div>\n
Boolean<\/div>\n
Default: false<\/div>\n<\/td>\n
If true, errors will be reported.<\/td>\n<\/tr>\n
\n
user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to imports file to a vector layer 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
First, create a FormData. Then add the values.<\/p>\n
let formData = new FormData();\r\nformData.append('file_uuid', '4f9f3e4b-4dc1-469b-83ab-00ae00f02581');\r\nformData.append('file_encoding', 'utf-8');\r\nformData.append('input_srid', 3857);\r\nformData.append('input_layer', 'province');\r\nformData.append('input_geom_type', 'POLYGON');<\/pre>\n
const result = await vectorLayer.importFile(formData);<\/pre>\n
export(options)<\/h3>\n
Exports the vector layer to different formats.<\/p>\n
Parameters:<\/strong><\/p>\n
options (FormData<\/a>)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
\n
out_format<\/div>\n<\/div>\n
String<\/div>\n<\/td>\n
Choices are: ‘Shapefile‘ | ‘GPKG’ | ‘GeoJSON’ | ‘CSV’ | ‘KML’ | ‘DXF’.<\/span><\/td>\n<\/tr>\n
\n
out_srid<\/div>\n
Number<\/div>\n
Deafult: 3857<\/div>\n<\/td>\n
srid of output layer.<\/td>\n<\/tr>\n
\n
q<\/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
bbox<\/div>\n
Array?<\/div>\n<\/td>\n
[southwest x, southwest y,\u00a0 northeast x, northeast y]<\/td>\n<\/tr>\n
\n
bbox_srid<\/div>\n
Number<\/div>\n
Deafult: 3857<\/div>\n<\/td>\n
srid of bounding box<\/td>\n<\/tr>\n
\n
feature_ids<\/div>\n
\n
Array?<\/div>\n<\/div>\n<\/td>\n
Comma separated list of ids for searching<\/td>\n<\/tr>\n
\n
fields<\/div>\n
Array?<\/div>\n<\/td>\n
Comma separated list of fields for searching<\/td>\n<\/tr>\n
\n
zipped<\/div>\n
Boolean<\/div>\n
Default: false<\/div>\n<\/td>\n
If true, the output is compressed.<\/td>\n<\/tr>\n
\n
run_async<\/div>\n
\n
Boolean<\/div>\n
Default: true<\/div>\n<\/div>\n<\/td>\n
If true, the process will be doing as a task, otherwise object will be returned directly.<\/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
First, create a FormData. Then add the values.<\/p>\n
let formData = new FormData();\r\nformData.append('out_format', 'Shapefile');\r\nformData.append('out_srid', 4326);\r\nformData.append('zipped', true);<\/pre>\n
const outputResult = await vectorLayer.export(formData);<\/pre>\n
After completing the desired task, use getTask<\/a> to access the task information, which also includes the file download link.<\/p>\n
calculateField(options)<\/h3>\n
Calculates new values for a field.<\/p>\n
Parameters:<\/strong><\/p>\n
options (FormData<\/a>)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
\n
target_field<\/div>\n<\/div>\n
String<\/div>\n<\/td>\n
Name of target field<\/td>\n<\/tr>\n
\n
expression<\/div>\n
String<\/div>\n<\/td>\n
Formula that calculates new values of the field.<\/td>\n<\/tr>\n
\n
q<\/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
bbox<\/div>\n
Array?<\/div>\n<\/td>\n
[southwest x, southwest y,\u00a0 northeast x, northeast y]<\/td>\n<\/tr>\n
\n
bbox_srid<\/div>\n
Number<\/div>\n
Deafult: 3857<\/div>\n<\/td>\n
srid of bounding box<\/td>\n<\/tr>\n
\n
feature_ids<\/div>\n
\n
Array?<\/div>\n<\/div>\n<\/td>\n
Comma separated list of ids for filtering features<\/td>\n<\/tr>\n
\n
run_async<\/div>\n
\n
Boolean<\/div>\n
Default: true<\/div>\n<\/div>\n<\/td>\n
If true, the process will be doing as a task, otherwise object will be returned directly.<\/td>\n<\/tr>\n
\n
user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to calculates field for a vector layer 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
First, create a FormData. Then add the values.<\/p>\n
let formData = new FormData();\r\nformData.append('target_field', 'area');\r\nformData.append('expression', 'length');\r\nformData.append('run_async', true);<\/pre>\n
const outputResult = await vectorLayer.calculateField(formData);<\/pre>\n","protected":false},"excerpt":{"rendered":"
Tip: After you access the vector layer object, the following methods and properties are applicable on the vector layer. Properties: uuid Returns the universally unique identifier\u00a0(UUID) of the vector layer. Returns: uuid: Returns uuid string. Example: const vectorLayerUuid = vectorLayer.uuid; name Returns the name of the vector layer. Returns: String: Returns vector layer name. Example: […]<\/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-6185","docs","type-docs","status-publish","hentry","doc_category-vector"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6185","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=6185"}],"version-history":[{"count":67,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6185\/revisions"}],"predecessor-version":[{"id":6666,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6185\/revisions\/6666"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6185"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6185"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6185"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}