{"id":6440,"date":"2023-01-12T11:41:50","date_gmt":"2023-01-12T08:11:50","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6440"},"modified":"2023-01-21T11:07:19","modified_gmt":"2023-01-21T07:37:19","slug":"map-object-2","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/map\/map-object-2\/","title":{"rendered":"Map object"},"content":{"rendered":"

Properties:<\/h2>\n

LibreMap<\/h3>\n

Returns the maplibre map object. After you access the maplibre map object, all the methods and properties of the maplibre-gl library can be applied to it.<\/p>\n

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

maplibre map<\/a>: Returns maplibre map object.<\/p>\n

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

const maplibretMap = map._internalMap;<\/pre>\n
_draw<\/h3>\n
Returns the draw object. Using this object, you can access to the complete information of the drawings. All new drawing capabilities, access to attributes of drawn features such as area of polygons or length of lines are available in this object.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns draw object.<\/p>\n
Example:<\/strong><\/p>\n
const draw = map._draw;<\/pre>\n
Methods:<\/h2>\n
<\/div>\n
\n
getFeatureLayers()<\/span><\/h3>\n<\/div>\n
Returns an array of created feature layers.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of feature layers.<\/p>\n
Example:<\/strong><\/p>\n
const featureLayers = await map.getFeatureLayers();<\/pre>\n
\n
\n
getRasterLayers()<\/span><\/h3>\n<\/div>\n
Returns an array of created raster layers.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of raster layers and mosaic layers.<\/p>\n
Example:<\/strong><\/p>\n
const featureLayers = await map.getFeatureLayers();<\/pre>\n
addScaleControl()<\/span><\/h3>\n<\/div>\n
Adds scale control to the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding scale control was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addScaleControl();<\/pre>\n
\n
removeScaleControl()<\/span><\/h3>\n<\/div>\n
Removes scale control from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing scale control was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeScaleControl();<\/pre>\n
\n
addBaseMaps()<\/span><\/h3>\n<\/div>\n
Adds base maps to the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding base maps was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addBaseMaps();<\/pre>\n
\n
removeBaseMaps()<\/span><\/h3>\n<\/div>\n
Removes base maps from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing base maps was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeBaseMaps();<\/pre>\n
\n
addSearchBar()<\/span><\/h3>\n<\/div>\n
Adds search bar to the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding search bar was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addSearchBar();<\/pre>\n
\n
removeSearchBar()<\/span><\/h3>\n<\/div>\n
Removes search bar from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing search bar was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeSearchBar();<\/pre>\n
\n
addCoordinatesViewer()<\/span><\/h3>\n<\/div>\n
Adds a panel to the map to show coordinates in UTM or geographic coordinate system.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding coordinates viewer was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addCoordinatesViewer();<\/pre>\n
\n
removeCoordinatesViewer()<\/span><\/h3>\n<\/div>\n
Removes coordinates viewer from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing coordinates viewer was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeCoordinatesViewer();<\/pre>\n
\n
addLegend()<\/span><\/h3>\n<\/div>\n
Adds legend to the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding legend was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addLegend();<\/pre>\n
\n
removeLegend()<\/span><\/h3>\n<\/div>\n
Removes legend from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing legend was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeLegend();<\/pre>\n
\n
addOverview()<\/span><\/h3>\n<\/div>\n
Adds overview map to the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding overview map was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addOverview();<\/pre>\n
\n
removeOverview()<\/span><\/h3>\n<\/div>\n
Removes overview map from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing overview map was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeOverview();<\/pre>\n
\n
addMeasurementTools()<\/span><\/h3>\n<\/div>\n
Adds measurement tools to the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding measurement tools was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.addMeasurementTools();<\/pre>\n
\n
removeMeasurementTools()<\/span><\/h3>\n<\/div>\n
Removes measurement tools from the map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing measurement tools was successful or not. Null message means removing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.removeMeasurementTools();<\/pre>\n
\n
openCoordinatePanel()<\/span><\/h3>\n<\/div>\n
Opens a panel to go to xy location.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows opening the panel was successful or not. Null message means opening was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.openCoordinatePanel();<\/pre>\n
\n
zoomToDefaultExtent()<\/span><\/h3>\n<\/div>\n
If a map is opened, zooms to map extent saved in geobox studio, if a layer is opened, zooms to layer extent.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows zooming was successful or not. Null message means zooming was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await map.zoomToDefaultExtent();<\/pre>\n","protected":false},"excerpt":{"rendered":"
Properties: LibreMap Returns the maplibre map object. After you access the maplibre map object, all the methods and properties of the maplibre-gl library can be applied to it. Returns: maplibre map: Returns maplibre map object. Example: const maplibretMap = map._internalMap; _draw Returns the draw object. Using this object, you can access to the complete information […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[60],"doc_tag":[],"class_list":["post-6440","docs","type-docs","status-publish","hentry","doc_category-map"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6440","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=6440"}],"version-history":[{"count":26,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6440\/revisions"}],"predecessor-version":[{"id":6623,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6440\/revisions\/6623"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6440"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6440"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6440"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}