{"id":6385,"date":"2023-01-10T14:33:07","date_gmt":"2023-01-10T11:03:07","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6385"},"modified":"2023-01-21T09:04:25","modified_gmt":"2023-01-21T05:34:25","slug":"map-object","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/map-geobox-api-for-leaflet\/map-object\/","title":{"rendered":"Map object"},"content":{"rendered":"

Properties:<\/h2>\n

Lmap<\/h3>\n

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

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

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

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

const leafletMap = map.Lmap;<\/pre>\n
_boundsLayer<\/h3>\n
Returns the extent information drawn on the map.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns bounding box information.<\/p>\n
Example:<\/strong><\/p>\n
const bBoxInfo= map._boundsLayer;<\/pre>\n
Methods:<\/h2>\n
addBaseLayer(baseMap, showAsDefault)<\/h3>\n
Adds base map to the map.<\/p>\n
Parameters:<\/strong><\/p>\n
baseMap is an object contains base map information. Choices are: GL.BaseLayers.OSM | GL.BaseLayers.Google | GL.BaseLayers.Mapbox (GL is geobox-leaflet.js object<\/a>).<\/p>\n
showAsDefault is a boolean parameter. If true, this base map is used as the default base map.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows adding base map was successful or not. Null message means adding was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = map.addBaseLayer(GL.BaseLayers.OSM, true);<\/pre>\n
zoomToBounds(latLngBounds, padding)<\/h3>\n
Zooms to the specified bounding box.<\/p>\n
Parameters:<\/strong><\/p>\n
latLngBounds (Object): Leaflet latLngBounds<\/a> object.<\/p>\n
padding is a number to create space between the bounds and the map.<\/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
vat\u00a0bounds\u00a0=\u00a0L.latLngBounds([35,51],[36,52]);\r\nconst result = map.zoomToBounds(bounds, 5);<\/pre>\n
zoomToWorld()<\/h3>\n
Zooms to the whole world extent.<\/p>\n
Example:<\/strong><\/p>\n
const result = map.zoomToWorld();<\/pre>\n
showSpinner()<\/h3>\n
Activates the spinner on the map. You can use this method before starting the time-consuming processes.<\/p>\n
Example:<\/strong><\/p>\n
map.showSpinner();<\/pre>\n
hideSpinner()<\/h3>\n
Deactivates the spinner.<\/p>\n
Example:<\/p>\n
map.hideSpinner();<\/pre>\n
openDialog(options)<\/h3>\n
Opens a new window to display information. This window can contain any information. This window can be moved.<\/p>\n
Parameters:<\/strong><\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.content<\/div>\n
Any<\/div>\n<\/td>\n
content can be a message string or can be any HTML element.<\/td>\n<\/tr>\n
\n
options.width<\/div>\n
Number?<\/div>\n<\/td>\n
width of the dialog window in pixel.<\/td>\n<\/tr>\n
\n
options.height<\/div>\n
Number?<\/div>\n<\/td>\n
height of the dialog window in pixel.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns dialog object.<\/p>\n
Example:<\/strong><\/p>\n
const dialog = map.openDialog({content: 'Welcome to Geobox', width: 300, height: 100});<\/pre>\n
closeDialog()<\/h3>\n
Closes the existing dialog window.<\/p>\n
Example:<\/strong><\/p>\n
map.closeDialog();<\/pre>\n
showMessage(message)<\/h3>\n
Opens a new window to display the desired message.<\/p>\n
Parameters:<\/strong><\/p>\n
message is a string that you want to show.<\/p>\n
Example:<\/strong><\/p>\n
map.showMessage('Welcome to Geobox');<\/pre>\n
startDrawingBounds()<\/h3>\n
Puts the map into draw mode so you can draw a bounding box.<\/p>\n
Example:<\/strong><\/p>\n
map.startDrawingBounds();<\/pre>\n
After drawing the bounding box, you can access the coordinates of the drawn bounding box using _boundsLayer<\/a>.<\/p>\n
cancelDrawingBounds()<\/h3>\n
Deactivates draw mode.<\/p>\n
Example:<\/strong><\/p>\n
map.cancelDrawingBounds();<\/pre>\n
displayBounds(latLngBounds)<\/h3>\n
Displays the bounding box on the map.<\/p>\n
Parameters:<\/strong><\/p>\n
latLngBounds (Object): Leaflet latLngBounds<\/a> object.<\/p>\n
Example:<\/strong><\/p>\n
map.displayBounds({'_southWest':\u00a0{'lat':\u00a031,'lng':\u00a052},'_northEast':\u00a0{'lat':\u00a034,'lng':\u00a057}});<\/pre>\n
clearBounds()<\/h3>\n
Deletes the existing drawn bounding box on the map.<\/p>\n
Example:<\/p>\n
map.clearBounds();<\/pre>\n
addButton(options)<\/h3>\n
Adds a new button on the map. When it is clicked, the function defined for it will be executed.<\/p>\n
Parameters:<\/strong><\/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.name<\/div>\n
String<\/div>\n<\/td>\n
Name of button.<\/td>\n<\/tr>\n
\n
options.tooltip<\/div>\n
String<\/div>\n<\/td>\n
Tooltip of button.<\/td>\n<\/tr>\n
\n
options.color<\/div>\n
String<\/div>\n<\/td>\n
Color of icon. Choices are: rgb color |\u00a0 rgba color | hex color.<\/td>\n<\/tr>\n
\n
options.icon<\/div>\n
String<\/div>\n<\/td>\n
Name of icon in google icons library<\/a>. (Google icons library should be added to the project)<\/td>\n<\/tr>\n
\n
options.click<\/div>\n
Function<\/div>\n<\/td>\n
Function that triggers when the button is clicked.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns button object.<\/p>\n
Example:<\/strong><\/p>\n
Tip: The fLayer is described in the featureLayer construction<\/a> section.<\/p>\n
const zoomBtn = map.addButton({\r\n   name: 'zoom',\r\n   tooltip: 'zoom to feature with id 100',\r\n   color: 'red',\r\n   icon: 'zoom_in',\r\n   click: () => {\r\n      fLayer.zoomTo(100);\r\n   }\r\n})<\/pre>\n","protected":false},"excerpt":{"rendered":"
Properties: Lmap Returns the leaflet map object. After you access the leaflet map object, all the methods and properties of the leaflet library can be applied to it. Returns: Leaflet map: Returns leaflet map object. Example: const leafletMap = map.Lmap; _boundsLayer Returns the extent information drawn on the map. Returns: Object: Returns bounding box information. […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[75],"doc_tag":[],"class_list":["post-6385","docs","type-docs","status-publish","hentry","doc_category-map-geobox-api-for-leaflet"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6385","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=6385"}],"version-history":[{"count":17,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6385\/revisions"}],"predecessor-version":[{"id":6612,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6385\/revisions\/6612"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6385"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6385"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6385"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}