OpenLayers JavaScript Mapping Library OpenLayers |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
Return the path to this script.
_getScriptLocation: function ()
OpenLayers JavaScript Mapping Library |
+
+OpenLayers. ClassContains functions to create OpenLayers style classes. Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OpenLayers. BoundsConstruct a new bounds object. Parameters
Return{OpenLayers.Bounds} A new bounds instance. clone
Create a cloned instance of this bounds. Return{OpenLayers.Bounds} A fresh copy of the bounds equals
Test a two bounds for equivalence Parameters
Return{Boolean} The passed-in OpenLayers.Bounds object has the same left, right, top, bottom components as this. Note that if bounds passed in is null, returns false. |
+
+
Create an OpenLayers style class
create: function()
Inherit from one or more OpenLayers style classes
inherit: function ()
Cast this object into a string
toString:function()
Return a clone of this pixel object
clone:function()
Determine whether one pixel is equivalent to another
equals:function( px )
Return the string representation of a size object
toString:function()
Create a clone of this size object
clone:function()
Create a cloned instance of this bounds.
clone:function()
Test a two bounds for equivalence
equals:function( bounds )
Log an object in the console.
log: function()
Writes a message to the console, including a hyperlink to the line where it was called.
debug: function()
Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
info: function()
Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
warn: function()
Writes a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called.
error: function()
Tests that an expression is true.
assert: function()
Prints an interactive listing of all properties of the object.
dir: function()
Prints the XML source tree of an HTML or XML element.
dirxml: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
trace: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
group: function()
Closes the most recently opened block created by a call to OpenLayers.Console.group
groupEnd: function()
Creates a new timer under the given name.
time: function()
OpenLayers JavaScript Mapping Library |
+
+OpenLayers. LayerSummary
gutter{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ clone
Parameters
Return{OpenLayers.Layer} An exact clone of this OpenLayers.Layer |
+
+
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
destroy: function( setNewBaseLayer )
clone: function ( obj )
OpenLayers JavaScript Mapping Library |
+
+OpenLayers. Layer. ImageInstances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer. Create a new image layer with the OpenLayers.Layer.Image constructor. Inherits from OpenLayers.Layer. Summary
+
+
+
+ extent{OpenLayers.Bounds} The image bounds in map units size{OpenLayers.Size} The image size in pixels OpenLayers. Layer. ImageCreate a new image layer Parameters
+
+
+
+
+
+ |
+
+
Destroy this layer
destroy: function()
Create a clone of this layer
clone: function( obj )
OpenLayers JavaScript Mapping Library |
+
+OpenLayers. Layer. VectorInstances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. Create a new image layer with the OpenLayers.Layer.Vector constructor. Inherits from OpenLayers.Layer. Summary
+
+
+
+ OpenLayers. Layer. VectorCreate a new vector layer Parameters
Return{OpenLayers.Layer.Vector} A new vector layer |
+
+
Destroy this layer
destroy: function()
OpenLayers JavaScript Mapping Library |
+
+OpenLayers. Layer.WMSInstances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. Create a new WMS layer with the OpenLayers.Layer.WMS constructor. Inherits from <OpenLayers.Layer.Grid>. Summary
+
+
+
+ OpenLayers. Layer.WMSCreate a new WMS layer object ExampleParameters
ReturnA new OpenLayers.Layer.WMS instance clone
Create a clone of this layer Return{OpenLayers.Layer.WMS} An exact clone of this layer getURL
Return a GetMap query string for this layer Parameters
Return{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters |
+
+
Destroy this layer
destroy: function()
Create a clone of this layer
clone: function ( obj )
Return a GetMap query string for this layer
getURL: function ( bounds )
OpenLayers JavaScript Mapping Library |
+
+OpenLayers.MapInstances of OpenLayers.Map are interactive maps embedded in a web page. Create a new map with the OpenLayers.Map constructor. Summary
+
+
+
+ size{OpenLayers.Size} Size of the main div (this.div)
+
+
+
+ layers{Array(OpenLayers.Layer} Ordered list of layers in the map
+
+
+
+
+
+ viewRequestID{String} Used to store a unique identifier that changes when the map view changes. viewRequestID should be used when adding data asynchronously to the map: viewRequestID is incremented when you initiate your request (right now during changing of baselayers and changing of zooms). It is stored here in the map and also in the data that will be coming back asynchronously. Before displaying this data on request completion, we check that the viewRequestID of the data is still the same as that of the map. Fix for #480 tileSize{OpenLayers.Size} Set in the map options to override the default tile size for this map.
+
+
+
+
+
+
+
+
+
+
+
+ maxExtent{OpenLayers.Bounds} The maximum extent for the map. Defaults to the whole world in decimal degrees (-180, -90, 180, 90). Specify a different extent in the map options if you are not using a geographic projection and displaying the whole world.
+
+
+
+
+
+ OpenLayers.MapConstructor for a new OpenLayers.Map instance. Parameters
Examples// create a map with default options in an element with the id "map1" ReturnA new OpenLayers.Map instance
+
+
+
+ getLayer
Get a layer based on its id Parameter
Return{OpenLayers.Layer} The Layer with the corresponding id from the map’s layer collection, or null if not found. |
+
+
Destroy this map
destroy:function()
Change the map options
setOptions: function( options )
Get the tile size for the map
getTileSize: function()
Get a layer based on its id
getLayer: function( id )
OpenLayers JavaScript Mapping Library | Class Index
The OpenLayers object provides a namespace for all things OpenLayers Instances of this class represent bounding boxes. Contains functions to create OpenLayers style classes. The OpenLayers.Console namespace is used for debugging and error logging. Instances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer. Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. Instances of OpenLayers.Map are interactive maps embedded in a web page. This class represents a screen coordinate, in x and y coordinates Instances of this class represent a width/height pair |
OpenLayers JavaScript Mapping Library | Constant Index
{String} OpenLayers.Layer.Image {String} OpenLayers.Layer.Vector {String} OpenLayers.Layer.WMS {String} OpenLayers.Map {Object} Hashtable of default parameter key/value pairs {Array} supported application event types {Integer} 256 {Integer} 256 {Object} Base z-indexes for different classes of thing |
OpenLayers JavaScript Mapping Library | Function Index
Return the path to this script. Tests that an expression is true. Construct a new bounds object. Create a cloned instance of this bounds.
Create a clone of this layer Create a clone of this layer Return a clone of this pixel object Create a clone of this size object Create an OpenLayers style class Writes a message to the console, including a hyperlink to the line where it was called. Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. Destroy this layer Destroy this layer Destroy this layer Destroy this map Prints an interactive listing of all properties of the object. Prints the XML source tree of an HTML or XML element. Test a two bounds for equivalence Determine whether one pixel is equivalent to another Writes a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called. Get a layer based on its id Get the tile size for the map Return a GetMap query string for this layer Writes a message to the console and opens a nested block to indent all future messages sent to the console. Closes the most recently opened block created by a call to OpenLayers.Console.group Create a new image layer Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called. Inherit from one or more OpenLayers style classes Log an object in the console. Constructor for a new OpenLayers.Map instance. Create a new OpenLayers.Pixel instance Change the map options Create an instance of OpenLayers.Size Creates a new timer under the given name. Cast this object into a string Return the string representation of a size object Prints an interactive stack trace of JavaScript execution at the point where it is called. Function that is called to destroy the map on page unload. Create a new vector layer Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called. Create a new WMS layer object |
OpenLayers JavaScript Mapping Library | Index
Return the path to this script. {String} Relative path of this script. {Number} The ratio of height/width represented by a single pixel in the graphic Tests that an expression is true. {Number} Construct a new bounds object. {OpenLayers.LonLat} The current center of the map {String} OpenLayers.Layer.Image {String} OpenLayers.Layer.Vector {String} OpenLayers.Layer.WMS {String} OpenLayers.Map Create a cloned instance of this bounds.
Create a clone of this layer Create a clone of this layer Return a clone of this pixel object Create a clone of this size object {Array(OpenLayers.Control) List of controls associated with the map Create an OpenLayers style class Writes a message to the console, including a hyperlink to the line where it was called. {Object} Hashtable of default parameter key/value pairs Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. Destroy this layer Destroy this layer Destroy this layer Destroy this map Prints an interactive listing of all properties of the object. Prints the XML source tree of an HTML or XML element. {Boolean} Request map tiles that are completely outside of the max extent for this layer. {DOMElement} The element that contains the map Test a two bounds for equivalence Determine whether one pixel is equivalent to another Writes a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called. {Array} supported application event types {OpenLayers.Events} An events object that handles all events on the map {OpenLayers.Bounds} The image bounds in map units {Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? Get a layer based on its id Get the tile size for the map Return a GetMap query string for this layer Writes a message to the console and opens a nested block to indent all future messages sent to the console. Closes the most recently opened block created by a call to OpenLayers.Console.group {Integer} Determines the width (in pixels) of the gutter around image tiles to ignore. {Number} height {String} Unique identifier for the map Create a new image layer Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called. Inherit from one or more OpenLayers style classes {Boolean} The layer is a base layer. {Boolean} The layer is a base layer. {HTMLDivElement} The element that contains the layers. {OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom) {Array(OpenLayers.Layer} Ordered list of layers in the map {Number} Log an object in the console. Constructor for a new OpenLayers.Map instance. {OpenLayers.Bounds} {OpenLayers.Bounds} The maximum extent for the map. {Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. {Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. {Number} {Number} {OpenLayers.Bounds} {OpenLayers.Bounds} {Number} {Number} {Number} {Integer} {Integer} Number of zoom levels for the map. The OpenLayers object provides a namespace for all things OpenLayers Instances of this class represent bounding boxes. Contains functions to create OpenLayers style classes. The OpenLayers.Console namespace is used for debugging and error logging. Instances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer. Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. Instances of OpenLayers.Map are interactive maps embedded in a web page. This class represents a screen coordinate, in x and y coordinates Instances of this class represent a width/height pair Create a new OpenLayers.Pixel instance {Array(OpenLayers.Popup) List of popups associated with the map {String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate. {String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate. {Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer. {Array} {Number} {Array} Change the map options {OpenLayers.Size} The image size in pixels {OpenLayers.Size} Size of the main div (this.div) Create an instance of OpenLayers.Size |
OpenLayers JavaScript Mapping Library | Index
{String} Relative path to a CSS file from which to load theme styles. {OpenLayers.Tile.Image} {Integer} 256 {Integer} 256 {OpenLayers.Size} Set in the map options to override the default tile size for this map. Creates a new timer under the given name. {Number} Cast this object into a string Return the string representation of a size object Prints an interactive stack trace of JavaScript execution at the point where it is called. {String} The layer map units. {String} The map units. Function that is called to destroy the map on page unload. {String} URL of the image to use Create a new vector layer {HTMLDivElement} The element that represents the map viewport {String} Used to store a unique identifier that changes when the map view changes. {Number} width Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called. Create a new WMS layer object {Boolean} #487 for more info. {Number} The x coordinate {Object} Base z-indexes for different classes of thing {Integer} The current zoom level of the map |
OpenLayers JavaScript Mapping Library | Property Index
{String} Relative path of this script. {Number} The ratio of height/width represented by a single pixel in the graphic {Number} {OpenLayers.LonLat} The current center of the map {Array(OpenLayers.Control) List of controls associated with the map {Boolean} Request map tiles that are completely outside of the max extent for this layer. {DOMElement} The element that contains the map {OpenLayers.Events} An events object that handles all events on the map {OpenLayers.Bounds} The image bounds in map units {Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? {Integer} Determines the width (in pixels) of the gutter around image tiles to ignore. {Number} height {String} Unique identifier for the map {Boolean} The layer is a base layer. {Boolean} The layer is a base layer. {HTMLDivElement} The element that contains the layers. {OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom) {Array(OpenLayers.Layer} Ordered list of layers in the map {Number} {OpenLayers.Bounds} {OpenLayers.Bounds} The maximum extent for the map. {Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. {Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. {Number} {Number} {OpenLayers.Bounds} {OpenLayers.Bounds} {Number} {Number} {Number} {Integer} {Integer} Number of zoom levels for the map. {Array(OpenLayers.Popup) List of popups associated with the map {String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate. {String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate. {Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer. {Array} {Number} {Array} {OpenLayers.Size} The image size in pixels {OpenLayers.Size} Size of the main div (this.div) {String} Relative path to a CSS file from which to load theme styles. {OpenLayers.Tile.Image} {OpenLayers.Size} Set in the map options to override the default tile size for this map. {Number} {String} The layer map units. {String} The map units. {String} URL of the image to use {HTMLDivElement} The element that represents the map viewport {String} Used to store a unique identifier that changes when the map view changes. {Number} width {Boolean} #487 for more info. {Number} The x coordinate {Integer} The current zoom level of the map |