{"id":6129,"date":"2023-01-01T13:31:38","date_gmt":"2023-01-01T10:01:38","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6129"},"modified":"2023-01-26T13:44:34","modified_gmt":"2023-01-26T10:14:34","slug":"working-with-rasterlayer","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/raster\/working-with-rasterlayer\/","title":{"rendered":"Raster datasets"},"content":{"rendered":"

Methods:<\/h2>\n

getRaster(raster_uuid)<\/h3>\n

Returns the desired existing raster layer. This function is an asynchronous function.<\/p>\n

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

raster_uuid is the available raster layer uuid.<\/p>\n

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

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

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

const rasterLayer = await Server.getRaster('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getRastersByIds(options)<\/h3>\n
Returns the desired existing raster 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 raster layers. If you want a single raster 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 raster 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 raster layers<\/a>.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayers = await Server.getRastersByIds({\r\n   'ids': [25,125],\r\n   'user_id' :0\r\n});<\/pre>\n
getRasterByName(name, user_id)<\/h3>\n
Returns the desired existing raster layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
name is the available raster layer name.<\/p>\n
user_id is the id of the user that raster layer belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Raster layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayer = await Server.getRasterByName('city',2);<\/pre>\n
getRasters(options)<\/h3>\n
Returns the desired existing raster 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
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\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 maps on each page is 1.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of raster layers.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayers = await Server.getRasters({q:`name = 'string'`,user_id :0});<\/pre>\n
getRasterInfo(raster_uuid)<\/h3>\n
Returns the desired existing raster layer information. This information includes extent and color bands of the raster layer.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains raster layer information.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerInfo = await Server.getRasterInfo('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getRasterPoint(raster_uuid, latitude, longitude)<\/h3>\n
Returns the desired existing raster layer information in a point (in a pixel).<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
latitude and longitude are geographic coordinates of the point.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array that contains pixel information.<\/p>\n
Example:<\/strong><\/p>\n
const pixelInfo = await Server.getRasterPoint('4f9f3e4b-4dc1-469b-83ab-00ae00f02581', 45, 32);<\/pre>\n
getRasterSettings(raster_uuid)<\/h3>\n
Returns the raster layer settings.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains raster layer settings.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerSettings = await Server.getRasterSettings('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
setRasterSettings(raster_uuid, options )<\/h3>\n
Updates the raster layer settings.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.visual_settings<\/div>\n
Object<\/div>\n<\/td>\n
An object contains visualization settings. See raster visualization<\/a>\u00a0for more guidance. e.g.:<\/p>\n
{\r\n      'nodata': null,\r\n      'indexes': [1],\r\n      'rescale': [[0,255]],\r\n      'colormap_name': null,\r\n      'colormap': null,\r\n      'color_formula': null,\r\n      'expression': null,\r\n      'exaggeration': 10\r\n}<\/pre>\n<\/td>\n<\/tr>\n
\n
options.tile_settings<\/div>\n
Object<\/div>\n<\/td>\n
An object contains tiles settings. See raster visualization<\/a>\u00a0for more guidance. e.g.:<\/p>\n
{\r\n      'min_zoom': 0,\r\n      'max_zoom': 22,\r\n      'use_cache': true,\r\n      'cache_until_zoom': 17\r\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains raster layer settings.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerSettings = await Server.setRasterSettings('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'visual_settings': {\r\n      'nodata': null,\r\n      'indexes': [1],\r\n      'rescale': [[0,255]],\r\n      'colormap_name': null,\r\n      'colormap': null,\r\n      'color_formula': null,\r\n      'expression': null,\r\n      'exaggeration': 10\r\n   },\r\n   'tile_settings': {\r\n      'min_zoom': 0,\r\n      'max_zoom': 22,\r\n      'use_cache': true,\r\n      'cache_until_zoom': 17\r\n   }\r\n});<\/pre>\n
getRasterStatistics(raster_uuid)<\/h3>\n
Returns the statistical information of the raster layer.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains raster layer statistics information.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerStatistics = await Server.getRasterStatistics('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getRasterTilejson(raster_uuid)<\/h3>\n
Returns raster layer tile information such as tile access address.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains information of raster layer tiles.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerTilejson = await Server.getRasterTilejson('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
updateRaster(raster_uuid, options )<\/h3>\n
Updates the existing raster layer.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster 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 raster layer.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of raster layer. This parameter is helpful in identifying raster layer easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of raster layer.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Raster layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayer = await Server.updateRaster('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string'\r\n});<\/pre>\n
deleteRaster(raster_uuid)<\/h3>\n
Deletes the existing raster layer.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster 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.deleteRaster('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
seedCacheRaster(raster_uuid, options)<\/h3>\n
Generates and stores tiles for the existing raster layer. See generating and storing tiles<\/a>\u00a0for more guidance.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/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
\n
options.extent<\/span><\/div>\n
Array<\/div>\n<\/div>\n<\/td>\n
[southwest x, southwest y,\u00a0 northeast x, northeast y]<\/span><\/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 build cache for a raster 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 Server.seedCacheRaster('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'from_zoom': 0,\r\n   'to_zoom': 2,\r\n   'extent': [51, 35, 52, 36],\r\n   'workers': 1,\r\n   'user_id': 2\r\n})<\/pre>\n
getCacheSizeRaster(raster_uuid)<\/h3>\n
Returns the size of tiles generated and stored for raster layer in bytes.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tiles size in byte.<\/p>\n
Example:<\/strong><\/p>\n
const tilesSize = await Server.getCacheSizeRaster('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
clearCacheRaster(raster_uuid)<\/h3>\n
Removes generated tiles for the desired raster layer.<\/p>\n
Parameters:<\/strong><\/p>\n
raster_uuid is the available raster layer uuid.<\/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 Server.clearCacheRaster('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
<\/h2>\n","protected":false},"excerpt":{"rendered":"
Methods: getRaster(raster_uuid) Returns the desired existing raster layer. This function is an asynchronous function. Parameters: raster_uuid is the available raster layer uuid. Returns: Raster layer: Returns itself to allow for method chaining. Example: const rasterLayer = await Server.getRaster(‘4f9f3e4b-4dc1-469b-83ab-00ae00f02581’); getRastersByIds(options) Returns the desired existing raster layers. This function is an asynchronous function. Parameters: options (Object) Name […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[68],"doc_tag":[],"class_list":["post-6129","docs","type-docs","status-publish","hentry","doc_category-raster"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6129","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=6129"}],"version-history":[{"count":30,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6129\/revisions"}],"predecessor-version":[{"id":6677,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6129\/revisions\/6677"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6129"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6129"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6129"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}