Wrld.rectangle(latLngBounds, options)
Extends: L.Rectangle
// Create a rectangle in San Francisco.
var rectangle = Wrld.rectangle([[37.767202, -122.456709], [37.766560, -122.455316]]).addTo(map);
Argument | Type | Description |
---|---|---|
latLngBounds | Wrld.LatLngBounds |
The bounds of the rectangle. |
options | object | Accepts all of the options to L.Rectangle , plus additional wrld.js entries. |
Options
Options | Type | Default | Description |
---|---|---|---|
elevation | number | 0.0 | Altitude above ground or sea level in meters. |
elevationMode | string | ‘heightAboveGround’ | Whether altitude is measured above ground level (“heightAboveGround”) or sea level (“heightAboveSeaLevel”). |
indoorMapId | string | ’’ | The id of the indoor map with which the Rectangle will be associated. |
indoorMapFloorId | number | 0 | The identifier of the indoor map floor on which the Rectangle should be displayed. In the WRLD Indoor Map Format, this corresponds to the ‘z_order’ field of the Level object. |
displayOption | string | ‘currentFloor’ | Controls when the Rectangle should be displayed in an indoor map. Option ‘currentIndoorMap’ will draw the Rectangle in the appropriate indoor map when any floor is selected; ‘currentFloor’ will draw the Rectangle only on the specified floor. |
Methods
getElevation()
Returns the elevation in meters.
setElevation(elevation)
Set the elevation in meters.
Argument | Type | Description |
---|---|---|
elevation | number | The elevation in meters. |
getElevationMode()
Returns the elevation mode.
setElevationMode(elevationMode)
Set the elevation mode.
Argument | Type | Description |
---|---|---|
elevationMode | string | Whether altitude is measured above ground level (“heightAboveGround”) or sea level (“heightAboveSeaLevel”). |
v1.1.0
- Wrld.map
- Wrld.map.indoors
- Wrld.map.themes
- Wrld.map.routes
- Wrld.map.buildings
- Wrld.map.props
- Wrld.map.indoorMapEntities
- Wrld.map.indoorMapFloorOutlines
- Wrld.Prop
- Wrld.indoorMapEntities .IndoorMapEntityInformation
- Wrld.indoorMapEntities.IndoorMapEntity
- Wrld.indoorMapFloorOutlines .IndoorMapFloorOutlineInformation
- Wrld.indoorMapFloorOutlines .IndoorMapFloorOutlinePolygon
- Wrld.indoorMapFloorOutlines .IndoorMapFloorOutlinePolygonRing
- Wrld.themes
- Wrld.Marker
- Wrld.Popup
- Wrld.Circle
- Wrld.Polygon
- Wrld.Polyline
- Wrld.Rectangle
- Wrld.native.Polygon
- Wrld.native.Polyline
- Wrld.Heatmap
- Wrld.buildings.BuildingHighlight
- Wrld.buildings.BuildingHighlightOptions
- Wrld.buildings.BuildingInformation
- Wrld.buildings.BuildingDimensions
- Wrld.buildings.BuildingContour
- Event objects
- WrldIndoorControl
- WrldMarkerController
- WrldSearchbar
- WrldNavigation
- WrldRouteView
- WrldIndoorPolygonEditor
- WrldPoiApi
- L.Map
- L.Marker
- L.Popup
- L.Tooltip
- L.TileLayer
- L.TileLayer.WMS
- L.ImageOverlay
- L.Path
- L.Polyline
- L.Polygon
- L.Rectangle
- L.Circle
- L.CircleMarker
- L.SVG
- L.Canvas
- L.LayerGroup
- L.FeatureGroup
- L.GeoJSON
- L.GridLayer
- L.LatLng
- L.LatLngBounds
- L.Point
- L.Bounds
- L.Icon
- L.DivIcon
- L.Control.Zoom
- L.Control.Attribution
- L.Control.Layers
- L.Control.Scale
- L.Browser
- L.Util
- L.Transformation
- L.LineUtil
- L.PolyUtil
- L.DomEvent
- L.DomUtil
- L.PosAnimation
- L.Draggable
- L.Class
- L.Evented
- L.Layer
- Interactive layer
- L.Control
- L.Handler
- L.Projection
- L.CRS
- L.Renderer
- Event objects
- L.DivOverlay
- Global Switches
- L.noConflict
- L.version
Map
Props
Indoor Map Entities
Indoor Map Floor Outlines
Themes
UI Layers
Vector Layers
Heatmaps
Buildings
Events
Widgets (Optional)
Services (Optional)
Leaflet
Map
Wrld.map
Wrld.map.indoors
Wrld.map.themes
Wrld.map.routes
Wrld.map.buildings
Wrld.map.props
Wrld.map.indoorMapEntities
Wrld.map.indoorMapFloorOutlines
Props
Wrld.Prop
Indoor Map Entities
Wrld.indoorMapEntities .IndoorMapEntityInformation
Wrld.indoorMapEntities.IndoorMapEntity
Indoor Map Floor Outlines
Wrld.indoorMapFloorOutlines .IndoorMapFloorOutlineInformation
Wrld.indoorMapFloorOutlines .IndoorMapFloorOutlinePolygon
Wrld.indoorMapFloorOutlines .IndoorMapFloorOutlinePolygonRing
Themes
Wrld.themes
UI Layers
Wrld.Marker
Wrld.Popup
Vector Layers
Wrld.Circle
Wrld.Polygon
Wrld.Polyline
Wrld.Rectangle
Wrld.native.Polygon
Wrld.native.Polyline
Heatmaps
Wrld.Heatmap
Buildings
Wrld.buildings.BuildingHighlight
Wrld.buildings.BuildingHighlightOptions
Wrld.buildings.BuildingInformation
Wrld.buildings.BuildingDimensions
Wrld.buildings.BuildingContour
Events
Event objects
Widgets (Optional)
WrldIndoorControl
WrldMarkerController
WrldSearchbar
WrldNavigation
WrldRouteView
WrldIndoorPolygonEditor
Services (Optional)
WrldPoiApi
Leaflet
L.Map
L.Marker
L.Popup
L.Tooltip
L.TileLayer
L.TileLayer.WMS
L.ImageOverlay
L.Path
L.Polyline
L.Polygon
L.Rectangle
L.Circle
L.CircleMarker
L.SVG
L.Canvas
L.LayerGroup
L.FeatureGroup
L.GeoJSON
L.GridLayer
L.LatLng
L.LatLngBounds
L.Point
L.Bounds
L.Icon
L.DivIcon
L.Control.Zoom
L.Control.Attribution
L.Control.Layers
L.Control.Scale
L.Browser
L.Util
L.Transformation
L.LineUtil
L.PolyUtil
L.DomEvent
L.DomUtil
L.PosAnimation
L.Draggable
L.Class
L.Evented
L.Layer
Interactive layer
L.Control
L.Handler
L.Projection
L.CRS
L.Renderer
Event objects
L.DivOverlay
Global Switches
L.noConflict
L.version