{"id":6219,"date":"2023-01-04T11:36:16","date_gmt":"2023-01-04T08:06:16","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6219"},"modified":"2023-01-26T13:37:10","modified_gmt":"2023-01-26T10:07:10","slug":"working-with-raster","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/raster\/working-with-raster\/","title":{"rendered":"Raster layer object"},"content":{"rendered":"

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

Properties:<\/h2>\n

uuid<\/h3>\n

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

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

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

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

const rasterLayerUuid = rasterLayer.uuid;<\/pre>\n
name<\/h3>\n
Returns the name of the raster layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns raster layer name.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerName = rasterLayer.name;<\/pre>\n
display_name<\/h3>\n
Returns the display name of the raster layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns display name of raster layer.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerDisplayName = rasterLayer.display_name;<\/pre>\n
description<\/h3>\n
Returns the description of the raster layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns raster layer description.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerDescription = rasterLayer.description;<\/pre>\n
created_at<\/h3>\n
Returns the time and date that the raster layer was created.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns raster layer created time.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerCreatedTime = rasterLayer.created_at;<\/pre>\n
last_modified_at<\/h3>\n
Returns the time and date that the raster layer is updated.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns raster layer updated time.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerModifiedTime = rasterLayer.last_modified_at;<\/pre>\n
is_shared<\/h3>\n
Indicates whether the raster layer is shared or not.<\/p>\n
Returns:<\/strong><\/p>\n
Boolean: If true, raster layer is shared.<\/p>\n
Example:<\/strong><\/p>\n
const isShared = rasterLayer.is_shared;<\/pre>\n
id<\/h3>\n
Returns the raster layer id.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns raster layer id.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerId = rasterLayer.id;<\/pre>\n
owner_id<\/h3>\n
Returns the user ID that the raster layer belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns raster layer owner id.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerOwnerId = rasterLayer.owner_id;<\/pre>\n
size<\/h3>\n
Returns the existing raster layer size in byte.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns raster layer size.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerSize = rasterLayer.size;<\/pre>\n
dtype<\/h3>\n
Returns the existing raster layer data type.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns data type of raster layer.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerDataType= rasterLayer.dtype;<\/pre>\n
band_count<\/h3>\n
Returns number of the raster layer bands.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns number of the raster layer bands.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerBandCount= rasterLayer.band_count;<\/pre>\n
width<\/h3>\n
Returns the raster layer width in pixel.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns number of raster layer width in pixel.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerWidth = rasterLayer.width;<\/pre>\n
height<\/h3>\n
Returns the raster layer height in pixel.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns number of raster layer height in pixel.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayerHeight= rasterLayer.height;<\/pre>\n
extent<\/h3>\n
Returns the coordinates of the raster 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 rasterLayerExtent = rasterLayer.extent;<\/pre>\n","protected":false},"excerpt":{"rendered":"
Tip: After you access the raster layer object, the following methods and properties are applicable on the raster layer. Properties: uuid Returns the universally unique identifier\u00a0(UUID) of the raster layer. Returns: uuid: Returns uuid string. Example: const rasterLayerUuid = rasterLayer.uuid; name Returns the name of the raster layer. Returns: String: Returns raster 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":[68],"doc_tag":[],"class_list":["post-6219","docs","type-docs","status-publish","hentry","doc_category-raster"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6219","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=6219"}],"version-history":[{"count":13,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6219\/revisions"}],"predecessor-version":[{"id":6668,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6219\/revisions\/6668"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6219"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6219"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6219"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}