OpenLayers. Control. OverviewMap
Create an overview map to display the extent of your main map and provide additional navigation control. Create a new overview map with the OpenLayers.Control.OverviewMap constructor.
Inerits from
element
{DOMElement} The DOM element that contains the overview map
size
{OpenLayers.Size} The overvew map size in pixels. Note that this is the size of the map itself - the element that contains the map (default class name olControlOverviewMapElement) may have padding or other style attributes added via CSS.
layers
{Array(OpenLayers.Layer)} Ordered list of layers in the overview map. If none are sent at construction, the base layer for the main map is used.
minRectSize
{Integer} The minimum width or height (in pixels) of the extent rectangle on the overview map. When the extent rectangle reaches this size, it will be replaced depending on the value of the minRectDisplayClass property. Default is 15 pixels.
minRectDisplayClass
{String} Replacement style class name for the extent rectangle when minRectSize is reached. This string will be suffixed on to the displayClass. Default is “RectReplacement”.
Example CSS declaration
.olControlOverviewMapRectReplacement {
overflow: hidden;
cursor: move;
background-image: url("img/overview_replacement.gif");
background-repeat: no-repeat;
background-position: center;
}
minRatio
{Float} The ratio of the overview map resolution to the main map resolution at which to zoom farther out on the overview map.
maxRatio
{Float} The ratio of the overview map resolution to the main map resolution at which to zoom farther in on the overview map.
mapOptions
{Object} An object containing any non-default properties to be sent to the overview map’s map constructor. These should include any non-default options that the main map was constructed with.
OpenLayers. Control. OverviewMap
Create a new overview map
Parameters
object | {Object} Properties of this object will be set on the overview map object. Note, to set options on the map object contained in this control, set mapOptions as one of the options properties. |
draw
Render the control in the browser.
baseLayerDraw
baseLayerDraw: function() |
Draw the base layer | called if unable to complete in the initial draw |
rectDrag
Handle extent rectangle drag
Parameters
mapDivClick
mapDivClick: function( | evt | ) |
|
Handle browser events
Parameters
maximizeControl
maximizeControl: function( | e | ) |
|
Unhide the control. Called when the control is in the map viewport.
Parameters
minimizeControl
minimizeControl: function( | e | ) |
|
Hide all the contents of the control, shrink the size, add the maximize icon
Parameters
showToggle
showToggle: function( | minimize | ) |
|
Hide/Show the toggle depending on whether the control is minimized
Parameters
update
Update the overview map after layers move.
isSuitableOverview
isSuitableOverview: function() |
Determines if the overview map is suitable given the extent and resolution of the main map.
createMap
Construct the map that this control contains
updateRectToMap
updateRectToMap: function() |
Updates the extent rectangle position and size to match the map extent
updateMapToRect
updateMapToRect: function() |
Updates the map extent to match the extent rectangle position and size
setRectPxBounds
setRectPxBounds: function( | pxBounds | ) |
|
Set extent rectangle pixel bounds.
Parameters
getRectBoundsFromMapBounds
getRectBoundsFromMapBounds: function( | lonLatBounds | ) |
|
Get the rect bounds from the map bounds.
Parameters
Returns
{OpenLayers.Bounds}A bounds which is the passed-in map lon/lat extent translated into pixel bounds for the overview map
getMapBoundsFromRectBounds
getMapBoundsFromRectBounds: function( | pxBounds | ) |
|
Get the map bounds from the rect bounds.
Parameters
Returns
{OpenLayers.Bounds} Bounds which is the passed-in overview rect bounds translated into lon/lat bounds for the overview map
getLonLatFromOverviewPx
getLonLatFromOverviewPx: function( | overviewMapPx | ) |
|
Get a map location from a pixel location
Parameters
Returns
{OpenLayers.LonLat} Location which is the passed-in overview map OpenLayers.Pixel, translated into lon/lat by the overview map
getOverviewPxFromLonLat
getOverviewPxFromLonLat: function( | lonlat | ) |
|
Get a pixel location from a map location
Parameters
Returns
{OpenLayers.Pixel} Location which is the passed-in OpenLayers.LonLat, translated into overview map pixels