{"id":6163,"date":"2023-01-02T13:04:56","date_gmt":"2023-01-02T09:34:56","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6163"},"modified":"2023-02-13T11:12:16","modified_gmt":"2023-02-13T07:42:16","slug":"geoprocessing-2","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/geoprocessing\/geoprocessing-2\/","title":{"rendered":"Buffer"},"content":{"rendered":"

buffer(option)<\/h3>\n

Buffers on the desired layer. After the process is finished, results are appeared as a new vector layer.<\/p>\n

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

options (FormData<\/a>)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
layer_uuid<\/div>\n
String<\/div>\n<\/td>\n
uuid of the vector layer or vector layer view.<\/td>\n<\/tr>\n
\n
is_view<\/div>\n
Bolean<\/div>\n
Deafult: false<\/div>\n<\/td>\n
If uuid is for a vector layer, this parameter should be false and if uuid is for a vector layer view, this parameter should be true.<\/td>\n<\/tr>\n
\n
buffer_distance<\/div>\n
Number<\/div>\n<\/td>\n
Buffer distance in meters.<\/td>\n<\/tr>\n
\n
out_layer_name<\/div>\n
String<\/div>\n<\/td>\n
Name of new layer for buffer results.<\/td>\n<\/tr>\n
\n
join_style<\/span><\/div>\n
String<\/div>\n
Default: null<\/div>\n<\/td>\n
Choices are: ‘Round’, ‘Mitre’, ‘Bevel’.<\/td>\n<\/tr>\n
\n
cap_style<\/div>\n
\n
String<\/div>\n
Default: null<\/div>\n<\/div>\n<\/td>\n
Choices are: ‘Round’, ‘Flat’, ‘Square’.<\/td>\n<\/tr>\n
\n
user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to do buffer geoprocessing for a vector layer or vector layer view 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('layer_uuid', '4f9f3e4b-4dc1-469b-83ab-00ae00f02581');\r\nformData.append('is_view', false);\r\nformData.append('buffer_distance', 10);\r\nformData.append('out_layer_name', 'buffer_10m');\r\nformData.append('join_style', 'Round');\r\nformData.append('cap_style', 'Round');\r\nformData.append('user_id', 2);<\/pre>\n
const newBufferLayer = await Server.buffer(formData);<\/pre>\n","protected":false},"excerpt":{"rendered":"
buffer(option) Buffers on the desired layer. After the process is finished, results are appeared as a new vector layer. Parameters: options (FormData) Name Description layer_uuid String uuid of the vector layer or vector layer view. is_view Bolean Deafult: false If uuid is for a vector layer, this parameter should be false and if uuid is […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[73],"doc_tag":[],"class_list":["post-6163","docs","type-docs","status-publish","hentry","doc_category-geoprocessing"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6163","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=6163"}],"version-history":[{"count":9,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6163\/revisions"}],"predecessor-version":[{"id":6689,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6163\/revisions\/6689"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6163"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6163"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6163"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}