{"id":6223,"date":"2023-01-04T12:40:33","date_gmt":"2023-01-04T09:10:33","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6223"},"modified":"2023-01-26T13:38:34","modified_gmt":"2023-01-26T10:08:34","slug":"working-with-mosaic-2","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/mosaic\/working-with-mosaic-2\/","title":{"rendered":"Raster mosaic layer object"},"content":{"rendered":"

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

Properties:<\/h2>\n

uuid<\/h3>\n

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

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

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

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

const mosaicLayerUuid = mosaicLayer.uuid;<\/pre>\n
name<\/h3>\n
Returns the name of the mosaic layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns name of mosaic layer.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerName = mosaicLayer.name;<\/pre>\n
display_name<\/h3>\n
Returns the display name of the mosaic layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns display name of mosaic layer.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerDisplayName = mosaicLayer.display_name;<\/pre>\n
description<\/h3>\n
Returns the description of the mosaic layer.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns mosaic layer description.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerDescription = mosaicLayer.description;<\/pre>\n
created_at<\/h3>\n
Returns the time and date that the mosaic layer was created.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns mosaic layer created time.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerCreatedTime = mosaicLayer.created_at;<\/pre>\n
last_modified_at<\/h3>\n
Returns the time and date that the mosaic layer is updated.<\/p>\n
Returns:<\/strong><\/p>\n
Date: Returns mosaic layer updated time.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerModifiedTime = mosaicLayer.last_modified_at;<\/pre>\n
is_shared<\/h3>\n
Indicates whether the mosaic layer is shared or not.<\/p>\n
Returns:<\/strong><\/p>\n
Boolean: If true, mosaic layer is shared.<\/p>\n
Example:<\/strong><\/p>\n
const isShared = mosaicLayer.is_shared;<\/pre>\n
id<\/h3>\n
Returns the mosaic layer id.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns mosaic layer id.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerId = mosaicLayer.id;<\/pre>\n
owner_id<\/h3>\n
Returns the user ID that the mosaic layer belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns mosaic layer owner id.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerOwnerId = mosaicLayer.owner_id;<\/pre>\n
dtype<\/h3>\n
Returns the existing mosaic layer data type.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns data type of mosaic layer.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerDataType= mosaicLayer.dtype;<\/pre>\n
band_count<\/h3>\n
Returns number of the mosaic layer bands.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns number of mosaic layer bands.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerBandCount= mosaicLayer.band_count;<\/pre>\n
pixel_selection<\/h3>\n
Returns how to select pixel values in overlapping regions.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns pixel selection algorithm.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerPixelSelection= mosaicLayer.pixel_selection;<\/pre>\n
raster_count<\/h3>\n
Returns the number of raster layers that compose the mosaic layer.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns number of raster layers forming the mosaic layer.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerHeight= mosaicLayer.raster_count;<\/pre>\n
extent<\/h3>\n
Returns the coordinates of the mosaic 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 mosaicLayerExtent = mosaicLayer.extent;<\/pre>\n","protected":false},"excerpt":{"rendered":"
Tip: After you access the mosaic layer object, the following methods and properties are applicable on the mosaic layer. Properties: uuid Returns the universally unique identifier\u00a0(UUID) of the mosaic layer. Returns: uuid: Returns uuid string. Example: const mosaicLayerUuid = mosaicLayer.uuid; name Returns the name of the mosaic layer. Returns: String: Returns name of mosaic layer. […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[69],"doc_tag":[],"class_list":["post-6223","docs","type-docs","status-publish","hentry","doc_category-mosaic"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6223","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=6223"}],"version-history":[{"count":10,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6223\/revisions"}],"predecessor-version":[{"id":6672,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6223\/revisions\/6672"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6223"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6223"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6223"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}