From 30d7044a6ab40a62a27ac9e8ddbf1ffbd8918854 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Wed, 20 Jun 2007 23:25:56 +0000 Subject: [PATCH] update with docs from crschmidt's recent changes git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3385 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf --- files/OpenLayers-js.html | 2 +- files/OpenLayers/BaseTypes-js.html | 2 +- files/OpenLayers/Console-js.html | 2 +- files/OpenLayers/Format-js.html | 2 +- files/OpenLayers/Geometry-js.html | 30 +++++++++++ files/OpenLayers/Geometry/Collection-js.html | 26 ++++++++++ .../Geometry/MultiLineString-js.html | 30 +++++++++++ files/OpenLayers/Layer-js.html | 2 +- files/OpenLayers/Layer/Image-js.html | 2 +- files/OpenLayers/Layer/Vector-js.html | 2 +- files/OpenLayers/Layer/WMS-js.html | 2 +- files/OpenLayers/Map-js.html | 2 +- files/OpenLayers/Marker-js.html | 50 +++++++++++++++++++ files/OpenLayers/Tile-js.html | 2 +- files/OpenLayers/Tile/Image-js.html | 2 +- files/OpenLayers/Tile/WFS-js.html | 2 +- index/Classes.html | 4 +- index/Constants.html | 12 ++--- index/Functions.html | 34 ++++++------- index/General.html | 20 ++++---- index/General2.html | 26 +++++----- index/Properties.html | 42 ++++++++-------- 22 files changed, 217 insertions(+), 81 deletions(-) create mode 100644 files/OpenLayers/Geometry-js.html create mode 100644 files/OpenLayers/Geometry/Collection-js.html create mode 100644 files/OpenLayers/Geometry/MultiLineString-js.html create mode 100644 files/OpenLayers/Marker-js.html diff --git a/files/OpenLayers-js.html b/files/OpenLayers-js.html index 78781e9716..4ba3e8cd00 100644 --- a/files/OpenLayers-js.html +++ b/files/OpenLayers-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers

The OpenLayers object provides a namespace for all things OpenLayers

Summary
OpenLayers
The OpenLayers object provides a namespace for all things OpenLayers
Properties
_scriptName
{String} Relative path of this script.
Functions
_getScriptLocation
Return the path to this script.
Constants
VERSION_NUMBER
diff --git a/files/OpenLayers/BaseTypes-js.html b/files/OpenLayers/BaseTypes-js.html index d0fc0e5c8b..6d735dddcf 100644 --- a/files/OpenLayers/BaseTypes-js.html +++ b/files/OpenLayers/BaseTypes-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Class

Contains functions to create OpenLayers style classes.

Summary
OpenLayers. Class
Contains functions to create OpenLayers style classes.
Functions
create
Create an OpenLayers style class
inherit
Inherit from one or more OpenLayers style classes
OpenLayers. Pixel
This class represents a screen coordinate, in x and y coordinates
Properties
x
{Number} The x coordinate
x
{Number} The x coordinate
Functions
OpenLayers. Pixel
Create a new OpenLayers.Pixel instance
toString
Cast this object into a string
clone
Return a clone of this pixel object
equals
Determine whether one pixel is equivalent to another
OpenLayers.Size
Instances of this class represent a width/height pair
Properties
w
{Number} width
h
{Number} height
Functions
OpenLayers.Size
Create an instance of OpenLayers.Size
toString
Return the string representation of a size object
clone
Create a clone of this size object
OpenLayers. LonLat
This class represents a longitude and latitude pair
Functions
OpenLayers. LonLat
Create a new OpenLayers.LonLat instance
toString
Return a readable string version of the lonlat
OpenLayers. Bounds
Instances of this class represent bounding boxes.
Properties
left
{Number}
bottom
{Number}
right
{Number}
top
{Number}
Functions
OpenLayers. Bounds
Construct a new bounds object.
clone
Create a cloned instance of this bounds.
equals
Test a two bounds for equivalence
oppositeQuadrant
Get the opposite quadrant for a given quadrant string.
diff --git a/files/OpenLayers/Console-js.html b/files/OpenLayers/Console-js.html index 242968dbf0..99687ca8ad 100644 --- a/files/OpenLayers/Console-js.html +++ b/files/OpenLayers/Console-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Console

The OpenLayers.Console namespace is used for debugging and error logging.  If the Firebug Lite (../Firebug/firebug.js) is included before this script, calls to OpenLayers.Console methods will get redirected to window.console.  This makes use of the Firebug extension where available and allows for cross-browser debugging Firebug style.

Note

Note that behavior will differ with the Firebug extention and Firebug Lite.  Most notably, the Firebug Lite console does not currently allow for hyperlinks to code or for clicking on object to explore their properties.

Summary
OpenLayers. Console
The OpenLayers.Console namespace is used for debugging and error logging.
Functions
log
Log an object in the console.
debug
Writes a message to the console, including a hyperlink to the line where it was called.
info
Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
warn
Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
error
Writes a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called.
assert
Tests that an expression is true.
dir
Prints an interactive listing of all properties of the object.
dirxml
Prints the XML source tree of an HTML or XML element.
trace
Prints an interactive stack trace of JavaScript execution at the point where it is called.
group
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
groupEnd
Closes the most recently opened block created by a call to OpenLayers.Console.group
time
Creates a new timer under the given name.
Constants
CLASS_NAME
diff --git a/files/OpenLayers/Format-js.html b/files/OpenLayers/Format-js.html index 1fb0a3a7a4..7276621a1e 100644 --- a/files/OpenLayers/Format-js.html +++ b/files/OpenLayers/Format-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Format

Base class for format reading/writing a variety of formats.  Subclasses of OpenLayers.Format are expected to have read and write methods.

Summary
OpenLayers. Format
Base class for format reading/writing a variety of formats.
Functions
OpenLayers. Format
Instances of this class are not useful.
read
Read data from a string, and return an object whose type depends on the subclass.
write
Accept an object, and return a string.
Constants
CLASS_NAME
{String} OpenLayers.Format
diff --git a/files/OpenLayers/Geometry-js.html b/files/OpenLayers/Geometry-js.html new file mode 100644 index 0000000000..10e5413f5b --- /dev/null +++ b/files/OpenLayers/Geometry-js.html @@ -0,0 +1,30 @@ + + +OpenLayers.Geometry - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry

A Geometry is a description of a geographic object.

Summary
OpenLayers. Geometry
A Geometry is a description of a geographic object.
Properties
bounds
{OpenLayers.Bounds}
Functions
OpenLayers. Geometry
Creates a geometry object.
+ +

Properties

+ +

bounds

{OpenLayers.Bounds}

+ +

Functions

+ +

OpenLayers. Geometry

Creates a geometry object.

Returns

{OpenLayers.Geometry} geometry.

+ +
Generated by Natural Docs
+ +
Instances of this class represent bounding boxes.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/Collection-js.html b/files/OpenLayers/Geometry/Collection-js.html new file mode 100644 index 0000000000..a79cba6999 --- /dev/null +++ b/files/OpenLayers/Geometry/Collection-js.html @@ -0,0 +1,26 @@ + + +OpenLayers.Geometry.Collection - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. Collection

A Collection is exactly what it sounds like: A collection of different Geometries.  These are stored in the local parameter “components” (which can be passed as a parameter to the constructor).

As new geometries are added to the collection, they are NOT cloned.  When removing geometries, they need to be specified by reference (ie you have to pass in the exact geometry to be removed).

The getArea() and getLength() functions here merely iterate through the components, summing their respective areas and lengths.

Inerhits from

Summary
OpenLayers. Geometry. Collection
A Collection is exactly what it sounds like: A collection of different Geometries.
Functions
OpenLayers. Geometry. Collection
Creates a Geometry Collection -- a list of geoms.
+ +

Functions

+ +

OpenLayers. Geometry. Collection

Creates a Geometry Collection -- a list of geoms.

Parameters

components{Array(OpenLayers.Geometry)}

Returns

{OpenLayers.Geometry.Collection}

+ +
Generated by Natural Docs
+ +
A Geometry is a description of a geographic object.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/MultiLineString-js.html b/files/OpenLayers/Geometry/MultiLineString-js.html new file mode 100644 index 0000000000..62a26bce20 --- /dev/null +++ b/files/OpenLayers/Geometry/MultiLineString-js.html @@ -0,0 +1,30 @@ + + +OpenLayers.Geometry.MultiLineString - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. MultiLineString

A MultiLineString is a collection of LineStrings.

Inherits from

Summary
OpenLayers. Geometry. MultiLineString
A MultiLineString is a collection of LineStrings.
Functions
OpenLayers. Geometry. MultiLineString
Constructor for a MultiLineString Geometry.
Constants
CLASS_NAME
Name of class.
+ +

Functions

+ +

OpenLayers. Geometry. MultiLineString

Constructor for a MultiLineString Geometry.

Parameters

components{Array(OpenLayers.Geometry.LineString)}

Return

OpenLayers.Geometry.MultiLineString object.

+ +

Constants

+ +

CLASS_NAME

Name of class.

+ +
Generated by Natural Docs
+ +
A Collection is exactly what it sounds like: A collection of different Geometries.
A Geometry is a description of a geographic object.
Constructor for a MultiLineString Geometry.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer-js.html b/files/OpenLayers/Layer-js.html index 18d1dec20b..9ffe8609a8 100644 --- a/files/OpenLayers/Layer-js.html +++ b/files/OpenLayers/Layer-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Layer

Summary
OpenLayers. Layer
Properties
gutter
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
projection
{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.
units
{String} The layer map units.
scales
{Array}
resolutions
{Array}
maxExtent
{OpenLayers.Bounds}
minExtent
{OpenLayers.Bounds}
maxResolution
{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
minResolution
{Number}
numZoomLevels
{Integer}
minScale
{Number}
maxScale
{Number}
displayOutsideMaxExtent
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
wrapDateLine
{Boolean} #487 for more info.
Functions
OpenLayers. Layer
destroy
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
clone
diff --git a/files/OpenLayers/Layer/Image-js.html b/files/OpenLayers/Layer/Image-js.html index a93362f660..bf5028b6c1 100644 --- a/files/OpenLayers/Layer/Image-js.html +++ b/files/OpenLayers/Layer/Image-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Layer. Image

Instances 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
OpenLayers. Layer. Image
Instances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer.
Properties
isBaseLayer
{Boolean} The layer is a base layer.
url
{String} URL of the image to use
extent
{OpenLayers.Bounds} The image bounds in map units
size
{OpenLayers.Size} The image size in pixels
tile
{OpenLayers.Tile.Image}
aspectRatio
{Number} The ratio of height/width represented by a single pixel in the graphic
Functions
OpenLayers. Layer. Image
Create a new image layer
destroy
Destroy this layer
clone
Create a clone of this layer
Constants
CLASS_NAME
{String} OpenLayers.Layer.Image
diff --git a/files/OpenLayers/Layer/Vector-js.html b/files/OpenLayers/Layer/Vector-js.html index d6d412e85f..4949cba2d0 100644 --- a/files/OpenLayers/Layer/Vector-js.html +++ b/files/OpenLayers/Layer/Vector-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Layer. Vector

Instances 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. Vector
Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
Properties
isBaseLayer
{Boolean} The layer is a base layer.
Functions
OpenLayers. Layer. Vector
Create a new vector layer
destroy
Destroy this layer
Constants
CLASS_NAME
{String} OpenLayers.Layer.Vector
diff --git a/files/OpenLayers/Layer/WMS-js.html b/files/OpenLayers/Layer/WMS-js.html index 8adfa7b4ea..bfbd96b6d5 100644 --- a/files/OpenLayers/Layer/WMS-js.html +++ b/files/OpenLayers/Layer/WMS-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Layer.WMS

Instances 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.WMS
Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services.
Constants
DEFAULT_PARAMS
{Object} Hashtable of default parameter key/value pairs
Properties
reproject
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
Functions
OpenLayers. Layer.WMS
Create a new WMS layer object
destroy
Destroy this layer
clone
Create a clone of this layer
getURL
Return a GetMap query string for this layer
Constants
CLASS_NAME
{String} OpenLayers.Layer.WMS
diff --git a/files/OpenLayers/Map-js.html b/files/OpenLayers/Map-js.html index ff22ddc0ef..4923d7a4a4 100644 --- a/files/OpenLayers/Map-js.html +++ b/files/OpenLayers/Map-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers.Map

Instances of OpenLayers.Map are interactive maps embedded in a web page.  Create a new map with the OpenLayers.Map constructor.

Summary
OpenLayers.Map
Instances of OpenLayers.Map are interactive maps embedded in a web page.
Constants
TILE_WIDTH
{Integer} 256
TILE_HEIGHT
{Integer} 256
Z_INDEX_BASE
{Object} Base z-indexes for different classes of thing
EVENT_TYPES
{Array} supported application event types
Properties and Functions
id
{String} Unique identifier for the map
events
{<OpenLayers.Events>} An events object that handles all events on the map
unloadDestroy
Function that is called to destroy the map on page unload.
div
{DOMElement} The element that contains the map
size
{OpenLayers.Size} Size of the main div (this.div)
viewPortDiv
{HTMLDivElement} The element that represents the map viewport
layerContainerOrigin
{OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom)
layerContainerDiv
{HTMLDivElement} The element that contains the layers.
layers
{Array(OpenLayers.Layer)} Ordered list of layers in the map
controls
{Array(<OpenLayers.Control>)} List of controls associated with the map
popups
{Array(<OpenLayers.Popup>)} List of popups associated with the map
baseLayer
center
{OpenLayers.LonLat} The current center of the map
zoom
{Integer} The current zoom level of the map
viewRequestID
{String} Used to store a unique identifier that changes when the map view changes.
tileSize
{OpenLayers.Size} Set in the map options to override the default tile size for this map.
projection
{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.
units
{String} The map units.
maxResolution
{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
minResolution
{Number}
maxScale
{Number}
minScale
maxExtent
{OpenLayers.Bounds} The maximum extent for the map.
minExtent
{OpenLayers.Bounds}
numZoomLevels
{Integer} Number of zoom levels for the map.
theme
{String} Relative path to a CSS file from which to load theme styles.
fallThrough
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
OpenLayers.Map
Constructor for a new OpenLayers.Map instance.
destroy
Destroy this map
setOptions
Change the map options
getTileSize
Get the tile size for the map
getLayer
Get a layer based on its id
Constants
CLASS_NAME
{String} OpenLayers.Map
diff --git a/files/OpenLayers/Marker-js.html b/files/OpenLayers/Marker-js.html new file mode 100644 index 0000000000..7d7b675798 --- /dev/null +++ b/files/OpenLayers/Marker-js.html @@ -0,0 +1,50 @@ + + +OpenLayers.Marker - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Marker

Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an <OpenLayers.Icon>.

Summary
OpenLayers. Marker
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an <OpenLayers.Icon>.
Properties
icon
{OpenLayers.Icon}
lonlat
{OpenLayers.LonLat} location of object
events
{<OpenLayers.Events>}
map
{OpenLayers.Map}
Functions
OpenLayers. Marker
draw
Calls draw on the icon, and returns that output.
moveTo
Move the marker to the new location.
onScreen
{Boolean} Whether or not the marker is currently visible on screen.
inflate
setOpacity
Change the opacity of the marker by changin the opacity of its icon
display
Hide or show the icon
defaultIcon
Creates a default <OpenLayers.Icon>.
+ +

Properties

+ +

icon

{OpenLayers.Icon}

+ +

lonlat

{OpenLayers.LonLat} location of object

+ +

events

{<OpenLayers.Events>}

+ +

map

{OpenLayers.Map}

+ +

Functions

+ +

OpenLayers. Marker

Paraemeters

icon{<OpenLayers.Icon>}
lonlat{OpenLayers.LonLat}
+ +

draw

draw: function(px)

Calls draw on the icon, and returns that output.

Parameters

px{OpenLayers.Pixel}

Return

{DOMElement} A new DOM Image with this marker’s icon set at the location passed-in

+ +

moveTo

moveTo: function (px)

Move the marker to the new location.

Parameters

px{OpenLayers.Pixel}
+ +

onScreen

onScreen:function()

Return

{Boolean} Whether or not the marker is currently visible on screen.

+ +

inflate

inflate: function(inflate)

Parameters

inflate{float}
+ +

setOpacity

setOpacity: function(opacity)

Change the opacity of the marker by changin the opacity of its icon

Parameters

opacity{float} Specified as fraction (0.4, etc)
+ +

display

display: function(display)

Hide or show the icon

display{Boolean}
+ +

defaultIcon

OpenLayers.Marker.defaultIcon = function()

Creates a default <OpenLayers.Icon>.

Returns

{<OpenLayers.Icon> A default OpenLayers.Icon to use for a marker

+ +
Generated by Natural Docs
+ +
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
draw: function(px)
Calls draw on the icon, and returns that output.
moveTo: function (px)
Move the marker to the new location.
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
inflate: function(inflate)
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
display: function(display)
Hide or show the icon
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Tile-js.html b/files/OpenLayers/Tile-js.html index 3bae50004a..46764020a9 100644 --- a/files/OpenLayers/Tile-js.html +++ b/files/OpenLayers/Tile-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers.Tile

This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.  Tiles store information about themselves -- such as the URL that they are related to, and their size - but do not add themselves to the layer div automatically, for example.  Create a new tile with the OpenLayers.Tile constructor, or a subclass.

TBD 3.0remove reference to url in above paragraph
Summary
OpenLayers.Tile
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Properties
id
{String} null
layer
{OpenLayers.Layer} layer the tile is attached to
url
{String} url of the request
bounds
{OpenLayers.Bounds} null
size
{OpenLayers.Size} null
position
{OpenLayers.Pixel} Top Left pixel of the tile
drawn
{Boolean} false
Functions
OpenLayers.Tile
Constructor for a new OpenLayers.Tile instance.
destroy
nullify references to prevent circular references and memory leaks
draw
Clear out existing tile, and return whether to draw or not.
moveTo
Reposition the tile.
clear
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
getBoundsFromBaseLayer
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
diff --git a/files/OpenLayers/Tile/Image-js.html b/files/OpenLayers/Tile/Image-js.html index 6d30de9329..ad67c51daf 100644 --- a/files/OpenLayers/Tile/Image-js.html +++ b/files/OpenLayers/Tile/Image-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Tile. Image

Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.  Create a new image tile with the OpenLayers.Tile.Image constructor.  Inherits from OpenLayers.Tile.

Summary
OpenLayers. Tile. Image
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Properties
url
{String} The URL of the image being requested.
imgDiv
{DOMElement} The div element which wraps the image.
frame
{DOMElement} The image element is appended to the frame.
Functions
OpenLayers. Tile. Image
Constructor for a new OpenLayers.Tile.Image instance.
destroy
nullify references to prevent circular references and memory leaks
draw
Check that a tile should be drawn, and draw it.
clear
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
moveTo
Reposition the tile.
initImgDiv
Creates the imgDiv property on the tile.
checkImgURL
Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime.
diff --git a/files/OpenLayers/Tile/WFS-js.html b/files/OpenLayers/Tile/WFS-js.html index 20f16747db..bc27e74350 100644 --- a/files/OpenLayers/Tile/WFS-js.html +++ b/files/OpenLayers/Tile/WFS-js.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Tile.WFS

Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.  Create a new image tile with the OpenLayers.Tile.WFS constructor.  Inherits from OpenLayers.Tile.

Summary
OpenLayers. Tile.WFS
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
Properties
features
{Array(<OpenLayers.Feature>)} list of features in this tile
url
{String}
Functions
OpenLayers. Tile.WFS
Constructor for a new OpenLayers.Tile.WFS instance.
destroy
nullify references to prevent circular references and memory leaks
clear
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
draw
Check that a tile should be drawn, and load features for it.
loadFeaturesForRegion
get the full request string from the ds and the tile params and call the AJAX loadURL().
requestSuccess
Called on return from request succcess.
addResults
Construct new feature via layer featureClass constructor, and add to this.features.
destroyAllFeatures
Iterate through and call destroy() on each feature, removing it from the local array
diff --git a/index/Classes.html b/index/Classes.html index 6db38f962a..6de601ea55 100644 --- a/index/Classes.html +++ b/index/Classes.html @@ -8,9 +8,9 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Class Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
O
 OpenLayers
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Format
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Pixel
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Class Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
O
 OpenLayers
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Format
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Pixel
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
-
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.
Base class for format reading/writing a variety of formats.
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.
This class represents a longitude and latitude pair
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
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
+
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.
Base class for format reading/writing a variety of formats.
A Geometry is a description of a geographic object.
A Collection is exactly what it sounds like: A collection of different Geometries.
A MultiLineString is a collection of LineStrings.
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.
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent a width/height pair
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Constants.html b/index/Constants.html index f98144b6ad..1760192fa3 100644 --- a/index/Constants.html +++ b/index/Constants.html @@ -8,21 +8,21 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Constant Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
C
 CLASS_NAME
OpenLayers. ConsoleOpenLayers. FormatOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
D
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
E
 EVENT_TYPES, OpenLayers.Map
T
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
V
 VERSION_NUMBER, OpenLayers
Z
 Z_INDEX_BASE, OpenLayers.Map
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Constant Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
C
 CLASS_NAME
OpenLayers. ConsoleOpenLayers. FormatOpenLayers. Geometry. MultiLineStringOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
D
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
E
 EVENT_TYPES, OpenLayers.Map
T
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
V
 VERSION_NUMBER, OpenLayers
Z
 Z_INDEX_BASE, OpenLayers.Map
-
{String} OpenLayers.Format
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
+
{String} OpenLayers.Format
Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
-
{Object} Hashtable of default parameter key/value pairs
+
{Object} Hashtable of default parameter key/value pairs
-
{Array} supported application event types
+
{Array} supported application event types
-
{Integer} 256
{Integer} 256
+
{Integer} 256
{Integer} 256
@@ -30,7 +30,7 @@ if (browserType) {document.write("
");if (browserV -
{Object} Base z-indexes for different classes of thing
+
{Object} Base z-indexes for different classes of thing
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Functions.html b/index/Functions.html index c3a2c56650..4e01efd11d 100644 --- a/index/Functions.html +++ b/index/Functions.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 _getScriptLocation, OpenLayers
A
 addResults, OpenLayers. Tile.WFS
 assert, OpenLayers. Console
B
 Bounds, OpenLayers. Bounds. OpenLayers
C
 checkImgURL, OpenLayers. Tile. Image
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 create, OpenLayers. Class
D
 debug, OpenLayers. Console
 destroy
OpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 draw
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
E
 equals
OpenLayers. BoundsOpenLayers. Pixel
 error, OpenLayers. Console
F
 Format, OpenLayers. Format. OpenLayers
G
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
I
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
L
 Layer, OpenLayers. Layer. OpenLayers
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 LonLat, OpenLayers. LonLat. OpenLayers
M
 Map, OpenLayers. Map. OpenLayers
 moveTo
OpenLayers.TileOpenLayers. Tile. Image
O
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
R
 read, OpenLayers. Format
 requestSuccess, OpenLayers. Tile.WFS
S
 setOptions, OpenLayers.Map
 Size, OpenLayers. Size. OpenLayers
T
 Tile, OpenLayers. Tile. OpenLayers
 time, OpenLayers. Console
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 unloadDestroy, OpenLayers.Map
V
 Vector, OpenLayers. Layer. Vector. OpenLayers. Layer
W
 warn, OpenLayers. Console
 WFS, OpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 write, OpenLayers. Format
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 _getScriptLocation, OpenLayers
A
 addResults, OpenLayers. Tile.WFS
 assert, OpenLayers. Console
B
 Bounds, OpenLayers. Bounds. OpenLayers
C
 checkImgURL, OpenLayers. Tile. Image
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 create, OpenLayers. Class
D
 debug, OpenLayers. Console
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display, OpenLayers. Marker
 draw
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
E
 equals
OpenLayers. BoundsOpenLayers. Pixel
 error, OpenLayers. Console
F
 Format, OpenLayers. Format. OpenLayers
G
 Geometry, OpenLayers. Geometry. OpenLayers
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
I
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 inflate, OpenLayers. Marker
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
L
 Layer, OpenLayers. Layer. OpenLayers
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 LonLat, OpenLayers. LonLat. OpenLayers
M
 Map, OpenLayers. Map. OpenLayers
 Marker, OpenLayers. Marker. OpenLayers
 moveTo
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
O
 onScreen, OpenLayers. Marker
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
R
 read, OpenLayers. Format
 requestSuccess, OpenLayers. Tile.WFS
S
 setOpacity, OpenLayers. Marker
 setOptions, OpenLayers.Map
 Size, OpenLayers. Size. OpenLayers
T
 Tile, OpenLayers. Tile. OpenLayers
 time, OpenLayers. Console
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 unloadDestroy, OpenLayers.Map
V
 Vector, OpenLayers. Layer. Vector. OpenLayers. Layer
W
 warn, OpenLayers. Console
 WFS, OpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 write, OpenLayers. Format
_getScriptLocation: function ()
Return the path to this script.
@@ -22,67 +22,67 @@ if (browserType) {document.write("
");if (browserV -
checkImgURL: function ()
Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
create: function()
Create an OpenLayers style class
+
checkImgURL: function ()
Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
Creates a Geometry Collection -- a list of geoms.
create: function()
Create an OpenLayers style class
-
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
destroy: function(setNewBaseLayer)
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()
Destroy this layer
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
+
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
destroy: function(setNewBaseLayer)
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()
Destroy this layer
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
display: function(display)
Hide or show the icon
draw: function(px)
Calls draw on the icon, and returns that output.
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
-
equals:function(bounds)
Test a two bounds for equivalence
equals:function(px)
Determine whether one pixel is equivalent to another
error: 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.
+
equals:function(bounds)
Test a two bounds for equivalence
equals:function(px)
Determine whether one pixel is equivalent to another
error: 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.
-
Instances of this class are not useful.
+
Instances of this class are not useful.
-
getBoundsFromBaseLayer: function(position)
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
getLayer: function(id)
Get a layer based on its id
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
groupEnd: function()
Closes the most recently opened block created by a call to OpenLayers.Console.group
+
Creates a geometry object.
getBoundsFromBaseLayer: function(position)
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
getLayer: function(id)
Get a layer based on its id
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
groupEnd: function()
Closes the most recently opened block created by a call to OpenLayers.Console.group
-
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
info: 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.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
+
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
inflate: function(inflate)
info: 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.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
-
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
log: function()
Log an object in the console.
Create a new OpenLayers.LonLat instance
+
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
log: function()
Log an object in the console.
Create a new OpenLayers.LonLat instance
-
Constructor for a new OpenLayers.Map instance.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
+
Constructor for a new OpenLayers.Map instance.
moveTo: function (px)
Move the marker to the new location.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
-
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
+
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
-
Create a new OpenLayers.Pixel instance
+
Create a new OpenLayers.Pixel instance
-
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
requestSuccess:function(request)
Called on return from request succcess.
+
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
requestSuccess:function(request)
Called on return from request succcess.
-
setOptions: function(options)
Change the map options
Create an instance of OpenLayers.Size
+
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOptions: function(options)
Change the map options
Create an instance of OpenLayers.Size
-
Constructor for a new OpenLayers.Tile instance.
time: function()
Creates a new timer under the given name.
toString:function()
Return a readable string version of the lonlat
toString:function()
Cast this object into a string
toString:function()
Return the string representation of a size object
trace: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
+
Constructor for a new OpenLayers.Tile instance.
time: function()
Creates a new timer under the given name.
toString:function()
Return a readable string version of the lonlat
toString:function()
Cast this object into a string
toString:function()
Return the string representation of a size object
trace: function()
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.
+
Function that is called to destroy the map on page unload.
-
Create a new vector layer
+
Create a new vector layer
-
warn: 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.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new WMS layer object
write: function(object)
Accept an object, and return a string.
+
warn: 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.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new WMS layer object
write: function(object)
Accept an object, and return a string.
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General.html b/index/General.html index 698be5830c..e2d0532e44 100644 --- a/index/General.html +++ b/index/General.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 _getScriptLocation, OpenLayers
 _scriptName, OpenLayers
A
 addResults, OpenLayers. Tile.WFS
 aspectRatio, OpenLayers. Layer. Image
 assert, OpenLayers. Console
B
 baseLayer, OpenLayers.Map
 bottom, OpenLayers. Bounds
 bounds, OpenLayers.Tile
 Bounds, OpenLayers. Bounds. OpenLayers
C
 center, OpenLayers.Map
 checkImgURL, OpenLayers. Tile. Image
 CLASS_NAME
OpenLayers. ConsoleOpenLayers. FormatOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Constants
OpenLayersOpenLayers. ConsoleOpenLayers. FormatOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 controls, OpenLayers.Map
 create, OpenLayers. Class
D
 debug, OpenLayers. Console
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
 destroy
OpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 displayOutsideMaxExtent, OpenLayers. Layer
 div, OpenLayers.Map
 draw
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawn, OpenLayers.Tile
E
 equals
OpenLayers. BoundsOpenLayers. Pixel
 error, OpenLayers. Console
 EVENT_TYPES, OpenLayers.Map
 events, OpenLayers.Map
 extent, OpenLayers. Layer. Image
F
 fallThrough, OpenLayers.Map
 features, OpenLayers. Tile.WFS
 Format, OpenLayers. Format. OpenLayers
 frame, OpenLayers. Tile. Image
 Functions
OpenLayersOpenLayers. BoundsOpenLayers. ClassOpenLayers. ConsoleOpenLayers. FormatOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. LonLatOpenLayers. PixelOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
G
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
I
 id
OpenLayers.MapOpenLayers.Tile
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 imgDiv, OpenLayers. Tile. Image
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer, OpenLayers.Tile
 Layer, OpenLayers. Layer. OpenLayers
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 LonLat, OpenLayers. LonLat. OpenLayers
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 _getScriptLocation, OpenLayers
 _scriptName, OpenLayers
A
 addResults, OpenLayers. Tile.WFS
 aspectRatio, OpenLayers. Layer. Image
 assert, OpenLayers. Console
B
 baseLayer, OpenLayers.Map
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers.Tile
 Bounds, OpenLayers. Bounds. OpenLayers
C
 center, OpenLayers.Map
 checkImgURL, OpenLayers. Tile. Image
 CLASS_NAME
OpenLayers. ConsoleOpenLayers. FormatOpenLayers. Geometry. MultiLineStringOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 Constants
OpenLayersOpenLayers. ConsoleOpenLayers. FormatOpenLayers. Geometry. MultiLineStringOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 controls, OpenLayers.Map
 create, OpenLayers. Class
D
 debug, OpenLayers. Console
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display, OpenLayers. Marker
 displayOutsideMaxExtent, OpenLayers. Layer
 div, OpenLayers.Map
 draw
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawn, OpenLayers.Tile
E
 equals
OpenLayers. BoundsOpenLayers. Pixel
 error, OpenLayers. Console
 EVENT_TYPES, OpenLayers.Map
 events
OpenLayers.MapOpenLayers. Marker
 extent, OpenLayers. Layer. Image
F
 fallThrough, OpenLayers.Map
 features, OpenLayers. Tile.WFS
 Format, OpenLayers. Format. OpenLayers
 frame, OpenLayers. Tile. Image
 Functions
OpenLayersOpenLayers. BoundsOpenLayers. ClassOpenLayers. ConsoleOpenLayers. FormatOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. MultiLineStringOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. LonLatOpenLayers. MarkerOpenLayers. PixelOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
G
 Geometry, OpenLayers. Geometry. OpenLayers
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
I
 icon, OpenLayers. Marker
 id
OpenLayers.MapOpenLayers.Tile
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 imgDiv, OpenLayers. Tile. Image
 inflate, OpenLayers. Marker
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer, OpenLayers.Tile
 Layer, OpenLayers. Layer. OpenLayers
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 lonlat, OpenLayers. Marker
 LonLat, OpenLayers. LonLat. OpenLayers
_getScriptLocation: function ()
Return the path to this script.
{String} Relative path of this script.
@@ -18,39 +18,39 @@ if (browserType) {document.write("
");if (browserV -
{Number}
{OpenLayers.Bounds} null
Construct a new bounds object.
+
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
Construct a new bounds object.
-
{OpenLayers.LonLat} The current center of the map
checkImgURL: function ()
Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime.
{String} OpenLayers.Format
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
{Array(OpenLayers.Control)} List of controls associated with the map
create: function()
Create an OpenLayers style class
+
{OpenLayers.LonLat} The current center of the map
checkImgURL: function ()
Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime.
{String} OpenLayers.Format
Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
Creates a Geometry Collection -- a list of geoms.
{Array(OpenLayers.Control)} List of controls associated with the map
create: function()
Create an OpenLayers style class
-
debug: function()
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: function(setNewBaseLayer)
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()
Destroy this layer
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
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
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
{Boolean} false
+
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
{Object} Hashtable of default parameter key/value pairs
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
destroy: function(setNewBaseLayer)
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()
Destroy this layer
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
display: function(display)
Hide or show the icon
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
{DOMElement} The element that contains the map
draw: function(px)
Calls draw on the icon, and returns that output.
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
{Boolean} false
-
equals:function(bounds)
Test a two bounds for equivalence
equals:function(px)
Determine whether one pixel is equivalent to another
error: 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.
{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
+
equals:function(bounds)
Test a two bounds for equivalence
equals:function(px)
Determine whether one pixel is equivalent to another
error: 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.
{Array} supported application event types
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{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? 
{Array(OpenLayers.Feature)} list of features in this tile
Instances of this class are not useful.
{DOMElement} The image element is appended to the frame.
+
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
{Array(OpenLayers.Feature)} list of features in this tile
Instances of this class are not useful.
{DOMElement} The image element is appended to the frame.
-
getBoundsFromBaseLayer: function(position)
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
getLayer: function(id)
Get a layer based on its id
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
groupEnd: function()
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.
+
Creates a geometry object.
getBoundsFromBaseLayer: function(position)
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
getLayer: function(id)
Get a layer based on its id
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
groupEnd: function()
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
+
{Number} height
-
{String} Unique identifier for the map
{String} null
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
{DOMElement} The div element which wraps the image.
info: 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.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
{Boolean} The layer is a base layer.
{Boolean} The layer is a base layer.
+
{OpenLayers.Icon}
{String} Unique identifier for the map
{String} null
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
{DOMElement} The div element which wraps the image.
inflate: function(inflate)
info: 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.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
{Boolean} The layer is a base layer.
{Boolean} The layer is a base layer.
-
{OpenLayers.Layer} layer the tile is attached to
{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}
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
log: function()
Log an object in the console.
Create a new OpenLayers.LonLat instance
+
{OpenLayers.Layer} layer the tile is attached to
{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}
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
log: function()
Log an object in the console.
{OpenLayers.LonLat} location of object
Create a new OpenLayers.LonLat instance
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General2.html b/index/General2.html index f7bdaa7c1c..8bc0411a4e 100644 --- a/index/General2.html +++ b/index/General2.html @@ -8,53 +8,53 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
M
 Map, OpenLayers. Map. OpenLayers
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
 moveTo
OpenLayers.TileOpenLayers. Tile. Image
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
O
 OpenLayers
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Format
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Pixel
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
 Properties
OpenLayersOpenLayers. BoundsOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 Properties and Functions, OpenLayers.Map
R
 read, OpenLayers. Format
 reproject, OpenLayers. Layer.WMS
 requestSuccess, OpenLayers. Tile.WFS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 setOptions, OpenLayers.Map
 size
OpenLayers. Layer. ImageOpenLayers.MapOpenLayers.Tile
 Size, OpenLayers. Size. OpenLayers
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 Tile, OpenLayers. Tile. OpenLayers
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
 tileSize, OpenLayers.Map
 time, OpenLayers. Console
 top, OpenLayers. Bounds
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 units
OpenLayers. LayerOpenLayers.Map
 unloadDestroy, OpenLayers.Map
 url
OpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 Vector, OpenLayers. Layer. Vector. OpenLayers. Layer
 VERSION_NUMBER, OpenLayers
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 warn, OpenLayers. Console
 WFS, OpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 wrapDateLine, OpenLayers. Layer
 write, OpenLayers. Format
X
 x, OpenLayers. Pixel
Z
 Z_INDEX_BASE, OpenLayers.Map
 zoom, OpenLayers.Map
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
M
 map, OpenLayers. Marker
 Map, OpenLayers. Map. OpenLayers
 Marker, OpenLayers. Marker. OpenLayers
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
 moveTo
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
O
 onScreen, OpenLayers. Marker
 OpenLayers
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Format
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Pixel
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
 Properties
OpenLayersOpenLayers. BoundsOpenLayers. GeometryOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. MarkerOpenLayers. PixelOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 Properties and Functions, OpenLayers.Map
R
 read, OpenLayers. Format
 reproject, OpenLayers. Layer.WMS
 requestSuccess, OpenLayers. Tile.WFS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 setOpacity, OpenLayers. Marker
 setOptions, OpenLayers.Map
 size
OpenLayers. Layer. ImageOpenLayers.MapOpenLayers.Tile
 Size, OpenLayers. Size. OpenLayers
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 Tile, OpenLayers. Tile. OpenLayers
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
 tileSize, OpenLayers.Map
 time, OpenLayers. Console
 top, OpenLayers. Bounds
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 units
OpenLayers. LayerOpenLayers.Map
 unloadDestroy, OpenLayers.Map
 url
OpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 Vector, OpenLayers. Layer. Vector. OpenLayers. Layer
 VERSION_NUMBER, OpenLayers
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 warn, OpenLayers. Console
 WFS, OpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 wrapDateLine, OpenLayers. Layer
 write, OpenLayers. Format
X
 x, OpenLayers. Pixel
Z
 Z_INDEX_BASE, OpenLayers.Map
 zoom, OpenLayers.Map
-
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}
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
+
{OpenLayers.Map}
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}
moveTo: function (px)
Move the marker to the new location.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
-
{Integer}
{Integer} Number of zoom levels for the map.
+
{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.
Base class for format reading/writing a variety of formats.
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.
This class represents a longitude and latitude pair
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
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
+
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
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.
Base class for format reading/writing a variety of formats.
A Geometry is a description of a geographic object.
A Collection is exactly what it sounds like: A collection of different Geometries.
A MultiLineString is a collection of LineStrings.
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.
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent a width/height pair
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
-
Create a new OpenLayers.Pixel instance
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
{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.
+
Create a new OpenLayers.Pixel instance
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
{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.
-
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
requestSuccess:function(request)
Called on return from request succcess.
{Array}
{Number}
+
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
requestSuccess:function(request)
Called on return from request succcess.
{Array}
{Number}
-
{Array}
setOptions: function(options)
Change the map options
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size} null
Create an instance of OpenLayers.Size
+
{Array}
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOptions: function(options)
Change the map options
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size} null
Create an instance of OpenLayers.Size
-
{String} Relative path to a CSS file from which to load theme styles.
{OpenLayers.Tile.Image}
Constructor for a new OpenLayers.Tile instance.
{Integer} 256
{Integer} 256
{OpenLayers.Size} Set in the map options to override the default tile size for this map.
time: function()
Creates a new timer under the given name.
{Number}
toString:function()
Return a readable string version of the lonlat
toString:function()
Cast this object into a string
toString:function()
Return the string representation of a size object
trace: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
+
{String} Relative path to a CSS file from which to load theme styles.
{OpenLayers.Tile.Image}
Constructor for a new OpenLayers.Tile instance.
{Integer} 256
{Integer} 256
{OpenLayers.Size} Set in the map options to override the default tile size for this map.
time: function()
Creates a new timer under the given name.
{Number}
toString:function()
Return a readable string version of the lonlat
toString:function()
Cast this object into a string
toString:function()
Return the string representation of a size object
trace: function()
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
{String} url of the request
{String} The URL of the image being requested.
{String}
+
{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
{String} url of the request
{String} The URL of the image being requested.
{String}
-
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.
+
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
warn: 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.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new WMS layer object
{Boolean} #487 for more info.
write: function(object)
Accept an object, and return a string.
+
{Number} width
warn: 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.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new WMS layer object
{Boolean} #487 for more info.
write: function(object)
Accept an object, and return a string.
-
{Number} The x coordinate
+
{Number} The x coordinate
-
{Object} Base z-indexes for different classes of thing
{Integer} The current zoom level of the map
+
{Object} Base z-indexes for different classes of thing
{Integer} The current zoom level of the map
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Properties.html b/index/Properties.html index e5744f681a..676a5e6a9c 100644 --- a/index/Properties.html +++ b/index/Properties.html @@ -8,7 +8,7 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Property Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 _scriptName, OpenLayers
A
 aspectRatio, OpenLayers. Layer. Image
B
 baseLayer, OpenLayers.Map
 bottom, OpenLayers. Bounds
 bounds, OpenLayers.Tile
C
 center, OpenLayers.Map
 controls, OpenLayers.Map
D
 displayOutsideMaxExtent, OpenLayers. Layer
 div, OpenLayers.Map
 drawn, OpenLayers.Tile
E
 events, OpenLayers.Map
 extent, OpenLayers. Layer. Image
F
 fallThrough, OpenLayers.Map
 features, OpenLayers. Tile.WFS
 frame, OpenLayers. Tile. Image
G
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
I
 id
OpenLayers.MapOpenLayers.Tile
 imgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer, OpenLayers.Tile
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
M
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
P
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
R
 reproject, OpenLayers. Layer.WMS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 size
OpenLayers. Layer. ImageOpenLayers.MapOpenLayers.Tile
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 tileSize, OpenLayers.Map
 top, OpenLayers. Bounds
U
 units
OpenLayers. LayerOpenLayers.Map
 url
OpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 wrapDateLine, OpenLayers. Layer
X
 x, OpenLayers. Pixel
Z
 zoom, OpenLayers.Map
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
Property Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 _scriptName, OpenLayers
A
 aspectRatio, OpenLayers. Layer. Image
B
 baseLayer, OpenLayers.Map
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers.Tile
C
 center, OpenLayers.Map
 controls, OpenLayers.Map
D
 displayOutsideMaxExtent, OpenLayers. Layer
 div, OpenLayers.Map
 drawn, OpenLayers.Tile
E
 events
OpenLayers.MapOpenLayers. Marker
 extent, OpenLayers. Layer. Image
F
 fallThrough, OpenLayers.Map
 features, OpenLayers. Tile.WFS
 frame, OpenLayers. Tile. Image
G
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
I
 icon, OpenLayers. Marker
 id
OpenLayers.MapOpenLayers.Tile
 imgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer, OpenLayers.Tile
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 lonlat, OpenLayers. Marker
M
 map, OpenLayers. Marker
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
P
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
R
 reproject, OpenLayers. Layer.WMS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 size
OpenLayers. Layer. ImageOpenLayers.MapOpenLayers.Tile
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 tileSize, OpenLayers.Map
 top, OpenLayers. Bounds
U
 units
OpenLayers. LayerOpenLayers.Map
 url
OpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 wrapDateLine, OpenLayers. Layer
X
 x, OpenLayers. Pixel
Z
 zoom, OpenLayers.Map
{String} Relative path of this script.
@@ -18,83 +18,83 @@ if (browserType) {document.write("
");if (browserV -
{Number}
{OpenLayers.Bounds} null
+
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
-
{OpenLayers.LonLat} The current center of the map
{Array(OpenLayers.Control)} List of controls associated with the map
+
{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
{Boolean} false
+
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
{DOMElement} The element that contains the map
{Boolean} false
-
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Bounds} The image bounds in map units
+
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{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? 
{Array(OpenLayers.Feature)} list of features in this tile
{DOMElement} The image element is appended to the frame.
+
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
{Array(OpenLayers.Feature)} list of features in this tile
{DOMElement} The image element is appended to the frame.
-
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
+
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
-
{Number} height
+
{Number} height
-
{String} Unique identifier for the map
{String} null
{DOMElement} The div element which wraps the image.
{Boolean} The layer is a base layer.
{Boolean} The layer is a base layer.
+
{OpenLayers.Icon}
{String} Unique identifier for the map
{String} null
{DOMElement} The div element which wraps the image.
{Boolean} The layer is a base layer.
{Boolean} The layer is a base layer.
-
{OpenLayers.Layer} layer the tile is attached to
{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.Layer} layer the tile is attached to
{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.LonLat} location of object
-
{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}
+
{OpenLayers.Map}
{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.
+
{Integer}
{Integer} Number of zoom levels for the map.
-
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
{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.
+
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
{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}
+
{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)
{OpenLayers.Size} null
+
{Array}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size} null
-
{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} 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
{String} url of the request
{String} The URL of the image being requested.
{String}
+
{String} The layer map units.
{String} The map units.
{String} URL of the image to use
{String} url of the request
{String} The URL of the image being requested.
{String}
-
{HTMLDivElement} The element that represents the map viewport
{String} Used to store a unique identifier that changes when the map view changes.
+
{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} width
{Boolean} #487 for more info.
-
{Number} The x coordinate
+
{Number} The x coordinate
-
{Integer} The current zoom level of the map
+
{Integer} The current zoom level of the map
Generated by Natural Docs
\ No newline at end of file