From 72757614601f0a69749f67522d5db818d6fad34b Mon Sep 17 00:00:00 2001 From: crschmidt Date: Thu, 21 Jun 2007 01:36:46 +0000 Subject: [PATCH] Regenerate docs again. looking almost real now. git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3399 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf --- files/OpenLayers-js.html | 6 +- files/OpenLayers/BaseTypes-js.html | 4 +- files/OpenLayers/Console-js.html | 4 +- files/OpenLayers/Control-js.html | 4 +- files/OpenLayers/Feature-js.html | 55 +++++++++++ files/OpenLayers/Feature/Vector-js.html | 51 ++++++++++ files/OpenLayers/Feature/WFS-js.html | 31 +++++++ files/OpenLayers/Format-js.html | 4 +- files/OpenLayers/Geometry-js.html | 4 +- files/OpenLayers/Geometry/Collection-js.html | 4 +- .../Geometry/MultiLineString-js.html | 4 +- files/OpenLayers/Geometry/MultiPoint-js.html | 4 +- files/OpenLayers/Geometry/Point-js.html | 4 +- files/OpenLayers/Geometry/Polygon-js.html | 4 +- files/OpenLayers/Icon-js.html | 55 +++++++++++ files/OpenLayers/Layer-js.html | 4 +- files/OpenLayers/Layer/Image-js.html | 4 +- files/OpenLayers/Layer/Vector-js.html | 4 +- files/OpenLayers/Layer/WMS-js.html | 4 +- files/OpenLayers/Map-js.html | 8 +- files/OpenLayers/Marker-js.html | 10 +- files/OpenLayers/Popup-js.html | 93 +++++++++++++++++++ files/OpenLayers/Tile-js.html | 4 +- files/OpenLayers/Tile/Image-js.html | 4 +- files/OpenLayers/Tile/WFS-js.html | 12 +-- index/Classes.html | 6 +- index/Constants.html | 12 ++- index/Files.html | 4 +- index/Functions.html | 40 +++----- index/Functions2.html | 32 +++++-- index/General.html | 26 ++---- index/General2.html | 22 ++--- index/General3.html | 22 ++--- index/General4.html | 37 ++++++++ index/Properties.html | 52 ++++++----- 35 files changed, 474 insertions(+), 164 deletions(-) create mode 100644 files/OpenLayers/Feature-js.html create mode 100644 files/OpenLayers/Feature/Vector-js.html create mode 100644 files/OpenLayers/Feature/WFS-js.html create mode 100644 files/OpenLayers/Icon-js.html create mode 100644 files/OpenLayers/Popup-js.html create mode 100644 index/General4.html diff --git a/files/OpenLayers-js.html b/files/OpenLayers-js.html index 0a1cf430c5..13ed95a4f7 100644 --- a/files/OpenLayers-js.html +++ b/files/OpenLayers-js.html @@ -8,10 +8,10 @@ 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 Classes in OpenLayers:

  • OpenLayers.Layer
  • OpenLayers.Layer.WMS
Summary
OpenLayers
The OpenLayers object provides a namespace for all things OpenLayers Classes in OpenLayers:
Properties
_scriptName
{String} Relative path of this script.
Functions
_getScriptLocation
Return the path to this script.
Constants
VERSION_NUMBER
+

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

Properties

diff --git a/files/OpenLayers/BaseTypes-js.html b/files/OpenLayers/BaseTypes-js.html index 116e5d85d8..255f616f43 100644 --- a/files/OpenLayers/BaseTypes-js.html +++ b/files/OpenLayers/BaseTypes-js.html @@ -8,8 +8,8 @@ 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 ef97b6876d..185ea16c59 100644 --- a/files/OpenLayers/Console-js.html +++ b/files/OpenLayers/Console-js.html @@ -8,8 +8,8 @@ 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/Control-js.html b/files/OpenLayers/Control-js.html index 9efc0f99d4..69e188b802 100644 --- a/files/OpenLayers/Control-js.html +++ b/files/OpenLayers/Control-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers/ Control.js

Summary
OpenLayers/ Control.js
Properties
active
{boolean} null
handler
{<OpenLayers.Handler}> null
diff --git a/files/OpenLayers/Feature-js.html b/files/OpenLayers/Feature-js.html new file mode 100644 index 0000000000..bed5119b3b --- /dev/null +++ b/files/OpenLayers/Feature-js.html @@ -0,0 +1,55 @@ + + +OpenLayers.Feature - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Feature

Features are combinations of geography and attributes.  The OpenLayers.Feature class specifically combines a marker and a lonlat.

Summary
OpenLayers. Feature
Features are combinations of geography and attributes.
Properties
events
{<OpenLayers.Events>}
layer
{OpenLayers.Layer}
id
{String}
lonlat
{OpenLayers.LonLat}
data
{Object}
marker
{OpenLayers.Marker}
popup
{OpenLayers.Popup}
Functions
OpenLayers. Feature
Constructor for features.
destroy
nullify references to prevent circular references and memory leaks
onScreen
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
createMarker
Based on the data associated with the Feature, create and return a marker object.
destroyMarker
Destroys marker.
createPopup
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
destroyPopup
Destroys the popup created via createPopup.
+ +

Properties

+ +

events

{<OpenLayers.Events>}

+ +

layer

{OpenLayers.Layer}

+ +

id

{String}

+ +

lonlat

{OpenLayers.LonLat}

+ +

data

{Object}

+ +

marker

{OpenLayers.Marker}

+ +

popup

{OpenLayers.Popup}

+ +

Functions

+ +

OpenLayers. Feature

Constructor for features.

Parameters

layer{OpenLayers.Layer}
lonlat{OpenLayers.LonLat}
data{Object}

Return

{OpenLayers.Feature}

+ +

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

onScreen

onScreen:function()

Returns

{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)

+ +

createMarker

createMarker: function()

Based on the data associated with the Feature, create and return a marker object.

Return

{OpenLayers.Marker} A Marker Object created from the ‘lonlat’ and ‘icon’ properties set in this.data.  If no ‘lonlat’ is set, returns null.  If no ‘icon’ is set, OpenLayers.Marker() will load the default image.

Notethis.marker is set to return value
+ +

destroyMarker

destroyMarker: function()

Destroys marker.  If user overrides the createMarker() function, s/he should be able to also specify an alternative function for destroying it

+ +

createPopup

createPopup: function(closeBox)

Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.  It uses this.marker.icon as default anchor.

If no ‘lonlat’ is set, returns null.  If no this.marker has been created, no anchor is sent.

Notethis.popup is set to return value

Parameters

closeBox{Boolean} create popup with closebox or not

Returns

{<OpenLayers.Popup.AnchoredBubble>}

+ +

destroyPopup

destroyPopup: function()

Destroys the popup created via createPopup.

As with the marker, if user overrides the createPopup() function, s/he should also be able to override the destruction

+ +
Generated by Natural Docs
+ +
This class represents a longitude and latitude pair
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
destroy: function()
nullify references to prevent circular references and memory leaks
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
destroyMarker: function()
Destroys marker.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
destroyPopup: function()
Destroys the popup created via createPopup.
Constructor for features.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Feature/Vector-js.html b/files/OpenLayers/Feature/Vector-js.html new file mode 100644 index 0000000000..5c37b311c9 --- /dev/null +++ b/files/OpenLayers/Feature/Vector-js.html @@ -0,0 +1,51 @@ + + +OpenLayers.Feature.Vector - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Feature. Vector

Vector features use the OpenLayers.Geometry classes as geometry description.  They have an ‘attributes’ property, which is the data object, and a ‘style’ property, the default values of which are defined in the OpenLayers.Feature.Vector.style objects.

Inherits from

Summary
OpenLayers. Feature. Vector
Vector features use the OpenLayers.Geometry classes as geometry description.
Properties
fid
{String}
geometry
{OpenLayers.Geometry}
attributes
{Object}
state
{String}
style
{Object}
Functions
OpenLayers. Feature. Vector
Create a vector feature.
destroy
nullify references to prevent circular references and memory leaks
clone
OpenLayers.Feature An exact clone of this OpenLayers.Feature
atPoint
Determins whether the feature intersects with the specified location.
toState
Sets the new state
Constants
OpenLayers. Feature. Vector. style
OpenLayers features can have a number of style attributes.
+ +

Properties

+ +

fid

{String}

+ +

geometry

{OpenLayers.Geometry}

+ +

attributes

{Object}

+ +

state

{String}

+ +

style

{Object}

+ +

Functions

+ +

OpenLayers. Feature. Vector

Create a vector feature.

Parameters

geometry{OpenLayers.Geometry}
data{Object}
style{Object}
+ +

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

clone

clone: function (obj)

Returns

OpenLayers.Feature An exact clone of this OpenLayers.Feature

+ +

atPoint

atPoint: function(lonlat,
toleranceLon,
toleranceLat)

Determins whether the feature intersects with the specified location.

Parameters

lonlat{OpenLayers.LonLat}
toleranceLon{float} Optional tolerance in Geometric Coords
toleranceLat{float} Optional tolerance in Geographic Coords

Returns

{Boolean} Whether or not the feature is at the specified location

+ +

toState

toState: function(state)

Sets the new state

Parameters

state{String}
+ +

Constants

+ +

OpenLayers. Feature. Vector. style

OpenLayers features can have a number of style attributes.  The ‘default’ style will typically be used if no other style is specified.

Default style properties

  • fillColor: “#ee9900”,
  • fillOpacity: 0.4,
  • hoverFillColor: “white”,
  • hoverFillOpacity: 0.8,
  • strokeColor: “#ee9900”,
  • strokeOpacity: 1,
  • strokeWidth: 1,
  • strokeLinecap: “round”,
  • hoverStrokeColor: “red”,
  • hoverStrokeOpacity: 1,
  • hoverStrokeWidth: 0.2,
  • pointRadius: 6,
  • hoverPointRadius: 1,
  • hoverPointUnit: “%”,
  • pointerEvents: “visiblePainted”
+ +
Generated by Natural Docs
+ +
A Geometry is a description of a geographic object.
destroy: function()
nullify references to prevent circular references and memory leaks
clone: function (obj)
OpenLayers.Feature An exact clone of this OpenLayers.Feature
Features are combinations of geography and attributes.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
toState: function(state)
Sets the new state
OpenLayers features can have a number of style attributes.
This class represents a longitude and latitude pair
+ + \ No newline at end of file diff --git a/files/OpenLayers/Feature/WFS-js.html b/files/OpenLayers/Feature/WFS-js.html new file mode 100644 index 0000000000..21cc13b3fe --- /dev/null +++ b/files/OpenLayers/Feature/WFS-js.html @@ -0,0 +1,31 @@ + + +OpenLayers.Feature.WFS - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Feature.WFS

WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.  Good for subclassing when creating a custom WFS like XML application.

Inherits from

Summary
OpenLayers. Feature.WFS
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
Functions
OpenLayers. Feature.WFS
Create a WFS feature.
destroy
nullify references to prevent circular references and memory leaks
processXMLNode
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
+ +

Functions

+ +

OpenLayers. Feature.WFS

Create a WFS feature.

Parameters

layer{OpenLayers.Layer}
xmlNode{XMLNode}
+ +

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

processXMLNode

processXMLNode: function(xmlNode)

When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.

For subclasses of Feature.WFS, this is the feature to change.

Parameters

xmlNode{XMLNode}

Return

{Object} Data Object with ‘id’, ‘lonlat’, and private properties set

+ +
Generated by Natural Docs
+ +
destroy: function()
nullify references to prevent circular references and memory leaks
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
Features are combinations of geography and attributes.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Format-js.html b/files/OpenLayers/Format-js.html index 0987783903..eabf23181f 100644 --- a/files/OpenLayers/Format-js.html +++ b/files/OpenLayers/Format-js.html @@ -8,8 +8,8 @@ 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 index 9f842f7ab8..2bd1546a2d 100644 --- a/files/OpenLayers/Geometry-js.html +++ b/files/OpenLayers/Geometry-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
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.
diff --git a/files/OpenLayers/Geometry/Collection-js.html b/files/OpenLayers/Geometry/Collection-js.html index 8a9f3ef950..16800c3e5a 100644 --- a/files/OpenLayers/Geometry/Collection-js.html +++ b/files/OpenLayers/Geometry/Collection-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
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.
diff --git a/files/OpenLayers/Geometry/MultiLineString-js.html b/files/OpenLayers/Geometry/MultiLineString-js.html index 6ec79b6ae2..3485a30345 100644 --- a/files/OpenLayers/Geometry/MultiLineString-js.html +++ b/files/OpenLayers/Geometry/MultiLineString-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
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.
diff --git a/files/OpenLayers/Geometry/MultiPoint-js.html b/files/OpenLayers/Geometry/MultiPoint-js.html index c32d197f16..a41ba7307c 100644 --- a/files/OpenLayers/Geometry/MultiPoint-js.html +++ b/files/OpenLayers/Geometry/MultiPoint-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. MultiPoint

MultiPoint is a collection of Points.

Inherits from

Summary
OpenLayers. Geometry. MultiPoint
MultiPoint is a collection of Points.
Functions
OpenLayers. Geometry. MultiPoint
Create a new MultiPoint Geometry
diff --git a/files/OpenLayers/Geometry/Point-js.html b/files/OpenLayers/Geometry/Point-js.html index ac8b10ca04..cbb36130df 100644 --- a/files/OpenLayers/Geometry/Point-js.html +++ b/files/OpenLayers/Geometry/Point-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. Point

Point geometry class.

Inherits from

Summary
OpenLayers. Geometry. Point
Point geometry class.
Properties
x
{float}
y
{float}
Functions
OpenLayers. Geometry. Point
Construct a point geometry.
clone
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
calculateBounds
Create a new Bounds based on the lon/lat
distanceTo
equals
toShortString
{String} Shortened String representation of Point object.
move
Moves a point in place
diff --git a/files/OpenLayers/Geometry/Polygon-js.html b/files/OpenLayers/Geometry/Polygon-js.html index b2f0a9a3b3..102f588c75 100644 --- a/files/OpenLayers/Geometry/Polygon-js.html +++ b/files/OpenLayers/Geometry/Polygon-js.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. Polygon

Polygon is a collection of Geometry.LinearRings.

Inherits from

Summary
OpenLayers. Geometry. Polygon
Polygon is a collection of Geometry.LinearRings.
Functions
OpenLayers. Geometry. Polygon
Constructor for a Polygon geometry.
getArea
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
diff --git a/files/OpenLayers/Icon-js.html b/files/OpenLayers/Icon-js.html new file mode 100644 index 0000000000..a53a6ff775 --- /dev/null +++ b/files/OpenLayers/Icon-js.html @@ -0,0 +1,55 @@ + + +OpenLayers.Icon - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers.Icon

Summary
OpenLayers.Icon
Properties
url
{String} image url
size
{OpenLayers.Size}
offset
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
calculateOffset
{OpenLayers.Pixel} Function to calculate the offset (based on the size)
imageDiv
{DOMElement}
px
{OpenLayers.Pixel}
Functions
OpenLayers.Icon
Creates an icon, which is an image tag in a div.
destroy
nullify references to prevent circular references and memory leaks
clone
{OpenLayers.Icon} A fresh copy of the icon.
setSize
draw
Move the div to the given pixel.
setOpacity
Change the icon’s opacity
moveTo
move icon to passed in px.
display
Hide or show the icon
+ +

Properties

+ +

url

{String} image url

+ +

size

{OpenLayers.Size}

+ +

offset

{OpenLayers.Pixel} distance in pixels to offset the image when being rendered

+ +

calculateOffset

{OpenLayers.Pixel} Function to calculate the offset (based on the size)

+ +

imageDiv

{DOMElement}

+ +

px

{OpenLayers.Pixel}

+ +

Functions

+ +

OpenLayers.Icon

Creates an icon, which is an image tag in a div.

url{String}
size{OpenLayers.Size}
calculateOffset{Function}
+ +

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

clone

clone: function()

Returns

{OpenLayers.Icon} A fresh copy of the icon.

+ +

setSize

setSize: function(size)
size{OpenLayers.Size}
+ +

draw

draw: function(px)

Move the div to the given pixel.

Parameters

px{OpenLayers.Pixel}

Returns

{DOMElement} A new DOM Image of this icon set at the location passed-in

+ +

setOpacity

setOpacity: function(opacity)

Change the icon’s opacity

Parameters

opacity{float}
+ +

moveTo

moveTo: function (px)

move icon to passed in px.

Parameters

px{OpenLayers.Pixel}
+ +

display

display: function(display)

Hide or show the icon

Parameters

display{Boolean}
+ +
Generated by Natural Docs
+ +
Instances of this class represent a width/height pair
This class represents a screen coordinate, in x and y coordinates
destroy: function()
nullify references to prevent circular references and memory leaks
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
Creates an icon, which is an image tag in a div.
setSize: function(size)
draw: function(px)
Move the div to the given pixel.
setOpacity: function(opacity)
Change the icon’s opacity
moveTo: function (px)
move icon to passed in px.
display: function(display)
Hide or show the icon
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer-js.html b/files/OpenLayers/Layer-js.html index 890a362b4e..5bd1a6775f 100644 --- a/files/OpenLayers/Layer-js.html +++ b/files/OpenLayers/Layer-js.html @@ -8,8 +8,8 @@ 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 92bd4fa68d..006b380970 100644 --- a/files/OpenLayers/Layer/Image-js.html +++ b/files/OpenLayers/Layer/Image-js.html @@ -8,8 +8,8 @@ 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 fd87cc2779..044fea44ed 100644 --- a/files/OpenLayers/Layer/Vector-js.html +++ b/files/OpenLayers/Layer/Vector-js.html @@ -8,8 +8,8 @@ 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

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 88375afc7a..9a97e93477 100644 --- a/files/OpenLayers/Layer/WMS-js.html +++ b/files/OpenLayers/Layer/WMS-js.html @@ -8,8 +8,8 @@ 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 0d31c0ccfd..44739b6e88 100644 --- a/files/OpenLayers/Map-js.html +++ b/files/OpenLayers/Map-js.html @@ -8,10 +8,10 @@ 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
+

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

Constants

@@ -45,7 +45,7 @@ if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 4

controls

{Array(<OpenLayers.Control>)} List of controls associated with the map

-

popups

{Array(<OpenLayers.Popup>)} List of popups associated with the map

+

popups

{Array(OpenLayers.Popup)} List of popups associated with the map

baseLayer

{<OpenLayers.Layer>} The currently selected base layerthis determines min/max zoom level, projection, etc.
diff --git a/files/OpenLayers/Marker-js.html b/files/OpenLayers/Marker-js.html index 87c72ee6bc..ecbdf42aa6 100644 --- a/files/OpenLayers/Marker-js.html +++ b/files/OpenLayers/Marker-js.html @@ -8,10 +8,10 @@ if (browserType) {document.write("
");if (browserV - +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
- diff --git a/files/OpenLayers/Popup-js.html b/files/OpenLayers/Popup-js.html new file mode 100644 index 0000000000..b0deae2a67 --- /dev/null +++ b/files/OpenLayers/Popup-js.html @@ -0,0 +1,93 @@ + + +OpenLayers.Popup - 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>.
+

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

@@ -25,7 +25,7 @@ if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 4

Functions

-

OpenLayers. Marker

Paraemeters

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

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

@@ -39,7 +39,7 @@ if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 4

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

+

defaultIcon

OpenLayers.Marker.defaultIcon = function()

Creates a default OpenLayers.Icon.

Returns

{OpenLayers.Icon} A default OpenLayers.Icon to use for a marker

+ + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Popup

Summary
OpenLayers. Popup
Properties
events
{<OpenLayers.Events>}
lonlat
{OpenLayers.LonLat}
div
{DOMElement}
size
{OpenLayers.Size}
contentHTML
{String}
backgroundColor
{String}
opacity
{float}
border
{String}
contentDiv
{DOMElement}
groupDiv
{DOMElement}
padding
{int}
map
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
Functions
OpenLayers. Popup
Create a popup.
destroy
nullify references to prevent circular references and memory leaks
draw
updatePosition
if the popup has a lonlat and its map members set, then have it move itself to its proper position
moveTo
visible
{Boolean} Boolean indicating whether or not the popup is visible
toggle
show
hide
setSize
setBackgroundColor
setOpacity
setBorder
setContentHTML
registerEvents
Registers events on the popup.
onmousedown
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseup
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onclick
Ignore clicks, but allowing default browser handling
onmouseout
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
ondblclick
Ignore double-clicks, but allowing default browser handling
+ +

Properties

+ +

events

{<OpenLayers.Events>}

+ +

lonlat

{OpenLayers.LonLat}

+ +

div

{DOMElement}

+ +

size

{OpenLayers.Size}

+ +

contentHTML

{String}

+ +

backgroundColor

{String}

+ +

opacity

{float}

+ +

border

{String}

+ +

contentDiv

{DOMElement}

+ +

groupDiv

{DOMElement}

+ +

padding

{int}

+ +

map

{OpenLayers.Map} this gets set in Map.js when the popup is added to the map

+ +

Functions

+ +

OpenLayers. Popup

Create a popup.

Parameters

id{String}
lonlat{OpenLayers.LonLat}
size{OpenLayers.Size}
contentHTML{String}
closeBox{Boolean}
+ +

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

draw

draw: function(px)

Parameters

px{OpenLayers.Pixel}

Return

{DOMElement} Reference to a div that contains the drawn popup

+ +

updatePosition

updatePosition: function()

if the popup has a lonlat and its map members set, then have it move itself to its proper position

+ +

moveTo

moveTo: function(px)

Parameters

px{OpenLayers.Pixel}
+ +

visible

visible: function()

Returns

{Boolean} Boolean indicating whether or not the popup is visible

+ +

toggle

toggle: function()
+ +

show

show: function()
+ +

hide

hide: function()
+ +

setSize

setSize:function(size)

Parameters

size{OpenLayers.Size}
+ +

setBackgroundColor

setBackgroundColor:function(color)

Parameters

color{String}
+ +

setOpacity

setOpacity:function(opacity)

Parameters

opacity{float}
+ +

setBorder

setBorder:function(border)

Parameters

border{int}
+ +

setContentHTML

setContentHTML:function(contentHTML)

Parameters

contentHTML{String}
+ +

registerEvents

registerEvents:function()

Registers events on the popup.

Do this in a separate function so that subclasses can choose to override it if they wish to deal differently with mouse events

Note in the following handler functions that some special care is needed to deal correctly with mousing and popups.

Because the user might select the zoom-rectangle option and then drag it over a popup, we need a safe way to allow the mousemove and mouseup events to pass through the popup when they are initiated from outside.

Otherwise, we want to essentially kill the event propagation for all other events, though we have to do so carefully, without disabling basic html functionality, like clicking on hyperlinks or drag-selecting text.

+ +

onmousedown

onmousedown: function (evt)

When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)

Parameters

evt{Event}
+ +

onmousemove

onmousemove: function (evt)

If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)

Parameters

evt{Event}
+ +

onmouseup

onmouseup: function (evt)

When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside

Parameters

evt{Event}
+ +

onclick

onclick: function (evt)

Ignore clicks, but allowing default browser handling

Parameters

evt{Event}
+ +

onmouseout

onmouseout: function (evt)

When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.

Parameters

evt{Event}
+ +

ondblclick

ondblclick: function (evt)

Ignore double-clicks, but allowing default browser handling

Parameters

evt{Event}
+ +
Generated by Natural Docs
+ +
This class represents a longitude and latitude pair
Instances of this class represent a width/height pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
destroy: function()
nullify references to prevent circular references and memory leaks
draw: function(px)
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
moveTo: function(px)
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
toggle: function()
show: function()
hide: function()
setSize:function(size)
setBackgroundColor:function(color)
setOpacity:function(opacity)
setBorder:function(border)
setContentHTML:function(contentHTML)
registerEvents:function()
Registers events on the popup.
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onclick: function (evt)
Ignore clicks, but allowing default browser handling
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
This class represents a screen coordinate, in x and y coordinates
+ + \ No newline at end of file diff --git a/files/OpenLayers/Tile-js.html b/files/OpenLayers/Tile-js.html index e0065bc476..f785816947 100644 --- a/files/OpenLayers/Tile-js.html +++ b/files/OpenLayers/Tile-js.html @@ -8,8 +8,8 @@ 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 5cc91240f2..4bc7184dfa 100644 --- a/files/OpenLayers/Tile/Image-js.html +++ b/files/OpenLayers/Tile/Image-js.html @@ -8,8 +8,8 @@ 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 a1b8d8ce3d..1364663b04 100644 --- a/files/OpenLayers/Tile/WFS-js.html +++ b/files/OpenLayers/Tile/WFS-js.html @@ -8,20 +8,20 @@ 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
+

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

Properties

-

features

{Array(<OpenLayers.Feature>)} list of features in this tile

+

features

{Array(OpenLayers.Feature)} list of features in this tile

url

{String}

Functions

-

OpenLayers. Tile.WFS

Constructor for a new OpenLayers.Tile.WFS instance.

Parameters

layer{OpenLayers.Layer} layer that the tile will go in.
position{OpenLayers.Pixel}
bounds{OpenLayers.Bounds}
url{<String>}
size{OpenLayers.Size}
+

OpenLayers. Tile.WFS

Constructor for a new OpenLayers.Tile.WFS instance.

Parameters

layer{OpenLayers.Layer} layer that the tile will go in.
position{OpenLayers.Pixel}
bounds{OpenLayers.Bounds}
url{<String>}
size{OpenLayers.Size}

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

@@ -41,7 +41,7 @@ if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 3
Generated by Natural Docs
-
Constructor for a new OpenLayers.Tile.WFS instance.
destroy: function()
nullify references to prevent circular references and memory leaks
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
draw:function()
Check that a tile should be drawn, and load features for it.
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
requestSuccess:function(request)
Called on return from request succcess.
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
+
Features are combinations of geography and attributes.
Constructor for a new OpenLayers.Tile.WFS instance.
destroy: function()
nullify references to prevent circular references and memory leaks
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
draw:function()
Check that a tile should be drawn, and load features for it.
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
requestSuccess:function(request)
Called on return from request succcess.
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
\ No newline at end of file diff --git a/index/Classes.html b/index/Classes.html index 7ec97a8811..148d972d69 100644 --- a/index/Classes.html +++ b/index/Classes.html @@ -8,10 +8,10 @@ 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. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 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
+
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. Feature
 OpenLayers. Feature. Vector
 OpenLayers. Feature.WFS
 OpenLayers. Format
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 OpenLayers.Icon
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Pixel
 OpenLayers. Popup
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
-
The OpenLayers object provides a namespace for all things OpenLayers Classes in 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.
MultiPoint is a collection of Points.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
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.
+
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.
Features are combinations of geography and attributes.
Vector features use the OpenLayers.Geometry classes as geometry description.
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
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.
MultiPoint is a collection of Points.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
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 a5f106c911..eca9e105f3 100644 --- a/index/Constants.html +++ b/index/Constants.html @@ -8,8 +8,8 @@ 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. 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
+
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
S
 style, OpenLayers. Feature. Vector. OpenLayers. Feature. Vector
T
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
V
 VERSION_NUMBER, OpenLayers
Z
 Z_INDEX_BASE, OpenLayers.Map
{String} OpenLayers.Format
Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
@@ -23,7 +23,11 @@ if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 5 -
{Integer} 256
{Integer} 256
+
OpenLayers features can have a number of style attributes.
+ + + +
{Integer} 256
{Integer} 256
@@ -31,7 +35,7 @@ if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 5 -
{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/Files.html b/index/Files.html index 95758a7d28..a41bbd94df 100644 --- a/index/Files.html +++ b/index/Files.html @@ -8,8 +8,8 @@ if (browserType) {document.write("
");if (browserV -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
File 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/ Control.js
+
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
File 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/ Control.js
diff --git a/index/Functions.html b/index/Functions.html index 15ab8cf5c3..eeabc7c827 100644 --- a/index/Functions.html +++ b/index/Functions.html @@ -8,66 +8,50 @@ 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
 calculateBounds, OpenLayers. Geometry. Point
 checkImgURL, OpenLayers. Tile. Image
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. 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
 distanceTo, OpenLayers. Geometry. Point
 draw
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
E
 equals
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. Pixel
 error, OpenLayers. Console
F
 Format, OpenLayers. Format. OpenLayers
G
 Geometry, OpenLayers. Geometry. OpenLayers
 getArea, OpenLayers. Geometry. Polygon
 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
 move, OpenLayers. Geometry. Point
 moveTo
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
O
 onScreen, OpenLayers. Marker
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
 Point, OpenLayers. Geometry. Point. OpenLayers. Geometry
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
R
 read, OpenLayers. Format
 requestSuccess, OpenLayers. Tile.WFS
S
 setOpacity, OpenLayers. Marker
 setOptions, OpenLayers.Map
 Size, OpenLayers. Size. OpenLayers
+
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
 atPoint, OpenLayers. Feature. Vector
B
 Bounds, OpenLayers. Bounds. OpenLayers
C
 calculateBounds, OpenLayers. Geometry. Point
 checkImgURL, OpenLayers. Tile. Image
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. Feature. VectorOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 create, OpenLayers. Class
 createMarker, OpenLayers. Feature
 createPopup, OpenLayers. Feature
D
 debug, OpenLayers. Console
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 destroyMarker, OpenLayers. Feature
 destroyPopup, OpenLayers. Feature
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display
OpenLayers.IconOpenLayers. Marker
 distanceTo, OpenLayers. Geometry. Point
 draw
OpenLayers.IconOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
E
 equals
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. Pixel
 error, OpenLayers. Console
F
 Feature, OpenLayers. Feature. OpenLayers
 Format, OpenLayers. Format. OpenLayers
G
 Geometry, OpenLayers. Geometry. OpenLayers
 getArea, OpenLayers. Geometry. Polygon
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
H
 hide, OpenLayers. Popup
I
 Icon, OpenLayers. Icon. OpenLayers
 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
_getScriptLocation: function ()
Return the path to this script.
-
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
assert: function()
Tests that an expression is true.
+
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
assert: function()
Tests that an expression is true.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
-
Construct a new bounds object.
+
Construct a new bounds object.
-
calculateBounds: function ()
Create a new Bounds based on the lon/lat
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)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
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
+
calculateBounds: function ()
Create a new Bounds based on the lon/lat
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)
OpenLayers.Feature An exact clone of this OpenLayers.Feature
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
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
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
-
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
distanceTo: function(point)
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.
+
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()
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
destroy: function()
nullify references to prevent circular references and memory leaks
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
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
destroyMarker: function()
Destroys marker.
destroyPopup: function()
Destroys the popup created via createPopup.
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
display: function(display)
Hide or show the icon
distanceTo: function(point)
draw: function(px)
Move the div to the given pixel.
draw: function(px)
Calls draw on the icon, and returns that output.
draw: function(px)
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(geom)
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(geom)
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.
+
Constructor for features.
Instances of this class are not useful.
-
Creates a geometry object.
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
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.
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
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.
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.
+
hide: function()
-
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
+
Creates an icon, which is an image tag in a div.
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.
-
Constructor for a new OpenLayers.Map instance.
move: function(x,
y)
Moves a point in place
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.
Create a new MultiPoint Geometry
- - - -
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
Construct a point geometry.
Constructor for a Polygon geometry.
- - - -
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.
- - - -
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
+
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
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Functions2.html b/index/Functions2.html index bca7d462f0..8497f30021 100644 --- a/index/Functions2.html +++ b/index/Functions2.html @@ -8,22 +8,42 @@ 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
T
 Tile, OpenLayers. Tile. OpenLayers
 time, OpenLayers. Console
 toShortString, OpenLayers. Geometry. Point
 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
M
 Map, OpenLayers. Map. OpenLayers
 Marker, OpenLayers. Marker. OpenLayers
 move, OpenLayers. Geometry. Point
 moveTo
OpenLayers.IconOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
O
 onclick, OpenLayers. Popup
 ondblclick, OpenLayers. Popup
 onmousedown, OpenLayers. Popup
 onmousemove, OpenLayers. Popup
 onmouseout, OpenLayers. Popup
 onmouseup, OpenLayers. Popup
 onScreen
OpenLayers. FeatureOpenLayers. Marker
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
 Point, OpenLayers. Geometry. Point. OpenLayers. Geometry
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 Popup, OpenLayers. Popup. OpenLayers
 processXMLNode, OpenLayers. Feature.WFS
R
 read, OpenLayers. Format
 registerEvents, OpenLayers. Popup
 requestSuccess, OpenLayers. Tile.WFS
S
 setBackgroundColor, OpenLayers. Popup
 setBorder, OpenLayers. Popup
 setContentHTML, OpenLayers. Popup
 setOpacity
OpenLayers.IconOpenLayers. MarkerOpenLayers. Popup
 setOptions, OpenLayers.Map
 setSize
OpenLayers.IconOpenLayers. Popup
 show, OpenLayers. Popup
 Size, OpenLayers. Size. OpenLayers
T
 Tile, OpenLayers. Tile. OpenLayers
 time, OpenLayers. Console
 toggle, OpenLayers. Popup
 toShortString, OpenLayers. Geometry. Point
 toState, OpenLayers. Feature. Vector
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 unloadDestroy, OpenLayers.Map
 updatePosition, OpenLayers. Popup
V
 Vector
OpenLayers. Feature. Vector. OpenLayers. FeatureOpenLayers. Layer. Vector. OpenLayers. Layer
 visible, OpenLayers. Popup
W
 warn, OpenLayers. Console
 WFS
OpenLayers. Feature. WFS. OpenLayers. FeatureOpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 write, OpenLayers. Format
-
Constructor for a new OpenLayers.Tile instance.
time: function()
Creates a new timer under the given name.
toShortString: function()
{String} Shortened String representation of Point object.
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.Map instance.
move: function(x,
y)
Moves a point in place
moveTo: function (px)
move icon to passed in px.
moveTo: function (px)
Move the marker to the new location.
moveTo: function(px)
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
Create a new MultiPoint Geometry
-
Function that is called to destroy the map on page unload.
+
onclick: function (evt)
Ignore clicks, but allowing default browser handling
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
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 vector layer
+
Create a new OpenLayers.Pixel instance
Construct a point geometry.
Constructor for a Polygon geometry.
Create a popup.
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
-
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.
+
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
registerEvents:function()
Registers events on the popup.
requestSuccess:function(request)
Called on return from request succcess.
+ + + +
setBackgroundColor:function(color)
setBorder:function(border)
setContentHTML:function(contentHTML)
setOpacity: function(opacity)
Change the icon’s opacity
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOpacity:function(opacity)
setOptions: function(options)
Change the map options
setSize: function(size)
setSize:function(size)
show: function()
Create an instance of OpenLayers.Size
+ + + +
Constructor for a new OpenLayers.Tile instance.
time: function()
Creates a new timer under the given name.
toggle: function()
toShortString: function()
{String} Shortened String representation of Point object.
toState: function(state)
Sets the new state
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.
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
+ + + +
Create a vector feature.
Create a new vector layer
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
+ + + +
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.
Create a WFS feature.
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 5cd5273e59..28258267d5 100644 --- a/index/General.html +++ b/index/General.html @@ -8,42 +8,30 @@ 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
 active
 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
 calculateBounds, OpenLayers. Geometry. Point
 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. Geometry. PointOpenLayers. 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
 distanceTo, OpenLayers. Geometry. Point
 div, OpenLayers.Map
 draw
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawn, OpenLayers.Tile
E
 equals
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. 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. Geometry. MultiPointOpenLayers. Geometry. PointOpenLayers. Geometry. PolygonOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. LonLatOpenLayers. MarkerOpenLayers. PixelOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
G
 Geometry, OpenLayers. Geometry. OpenLayers
 getArea, OpenLayers. Geometry. Polygon
 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
 handler
+
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
 active
 addResults, OpenLayers. Tile.WFS
 aspectRatio, OpenLayers. Layer. Image
 assert, OpenLayers. Console
 atPoint, OpenLayers. Feature. Vector
 attributes, OpenLayers. Feature. Vector
B
 backgroundColor, OpenLayers. Popup
 baseLayer, OpenLayers.Map
 border, OpenLayers. Popup
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers.Tile
 Bounds, OpenLayers. Bounds. OpenLayers
C
 calculateBounds, OpenLayers. Geometry. Point
 calculateOffset, OpenLayers.Icon
 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. Feature. VectorOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 Constants
OpenLayersOpenLayers. ConsoleOpenLayers. Feature. VectorOpenLayers. FormatOpenLayers. Geometry. MultiLineStringOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 contentDiv, OpenLayers. Popup
 contentHTML, OpenLayers. Popup
 controls, OpenLayers.Map
 create, OpenLayers. Class
 createMarker, OpenLayers. Feature
 createPopup, OpenLayers. Feature
D
 data, OpenLayers. Feature
 debug, OpenLayers. Console
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 destroyMarker, OpenLayers. Feature
 destroyPopup, OpenLayers. Feature
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display
OpenLayers.IconOpenLayers. Marker
 displayOutsideMaxExtent, OpenLayers. Layer
 distanceTo, OpenLayers. Geometry. Point
 div
OpenLayers.MapOpenLayers. Popup
 draw
OpenLayers.IconOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawn, OpenLayers.Tile
E
 equals
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. Pixel
 error, OpenLayers. Console
 EVENT_TYPES, OpenLayers.Map
 events
OpenLayers. FeatureOpenLayers.MapOpenLayers. MarkerOpenLayers. Popup
 extent, OpenLayers. Layer. Image
_getScriptLocation: function ()
Return the path to this script.
{String} Relative path of this script.
-
{boolean} null
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
{Number} The ratio of height/width represented by a single pixel in the graphic
assert: function()
Tests that an expression is true.
+
{boolean} null
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
{Number} The ratio of height/width represented by a single pixel in the graphic
assert: function()
Tests that an expression is true.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
{Object}
-
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
Construct a new bounds object.
+
{String}
{String}
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
Construct a new bounds object.
-
calculateBounds: function ()
Create a new Bounds based on the lon/lat
{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)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
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
+
calculateBounds: function ()
Create a new Bounds based on the lon/lat
{OpenLayers.Pixel} Function to calculate the offset (based on the size)
{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)
OpenLayers.Feature An exact clone of this OpenLayers.Feature
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
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.
{DOMElement}
{String}
{Array(OpenLayers.Control)} List of controls associated with the map
create: function()
Create an OpenLayers style class
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
-
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.
distanceTo: function(point)
{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
+
{Object}
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()
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
destroy: function()
nullify references to prevent circular references and memory leaks
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
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
destroyMarker: function()
Destroys marker.
destroyPopup: function()
Destroys the popup created via createPopup.
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
display: function(display)
Hide or show the icon
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
distanceTo: function(point)
{DOMElement} The element that contains the map
{DOMElement}
draw: function(px)
Move the div to the given pixel.
draw: function(px)
Calls draw on the icon, and returns that output.
draw: function(px)
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(geom)
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.
- - - -
Creates a geometry object.
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
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
{OpenLayers.Handler} null
+
equals:function(bounds)
Test a two bounds for equivalence
equals:function(geom)
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}
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{OpenLayers.Events}
{OpenLayers.Bounds} The image bounds in map units
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General2.html b/index/General2.html index ce3d311e0c..81c31083f5 100644 --- a/index/General2.html +++ b/index/General2.html @@ -8,38 +8,34 @@ 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
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
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
 move, OpenLayers. Geometry. Point
 moveTo
OpenLayers. MarkerOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. 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. Geometry. MultiPoint
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 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
 OpenLayers/ Control.js
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
 Point, OpenLayers. Geometry. Point. OpenLayers. Geometry
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
 Properties
GlobalOpenLayersOpenLayers. BoundsOpenLayers. GeometryOpenLayers. Geometry. PointOpenLayers. 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
+
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
F
 fallThrough, OpenLayers.Map
 Feature, OpenLayers. Feature. OpenLayers
 features, OpenLayers. Tile.WFS
 fid, OpenLayers. Feature. Vector
 Format, OpenLayers. Format. OpenLayers
 frame, OpenLayers. Tile. Image
 Functions
OpenLayersOpenLayers. BoundsOpenLayers. ClassOpenLayers. ConsoleOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers. FormatOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. MultiLineStringOpenLayers. Geometry. MultiPointOpenLayers. Geometry. PointOpenLayers. Geometry. PolygonOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. LonLatOpenLayers. MarkerOpenLayers. PixelOpenLayers. PopupOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
G
 geometry, OpenLayers. Feature. Vector
 Geometry, OpenLayers. Geometry. OpenLayers
 getArea, OpenLayers. Geometry. Polygon
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupDiv, OpenLayers. Popup
 groupEnd, OpenLayers. Console
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
 handler
 hide, OpenLayers. Popup
I
 icon, OpenLayers. Marker
 Icon, OpenLayers. Icon. OpenLayers
 id
OpenLayers. FeatureOpenLayers.MapOpenLayers.Tile
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 imageDiv, OpenLayers.Icon
 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. FeatureOpenLayers.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. FeatureOpenLayers. MarkerOpenLayers. Popup
 LonLat, OpenLayers. LonLat. OpenLayers
M
 map
OpenLayers. MarkerOpenLayers. Popup
 Map, OpenLayers. Map. OpenLayers
 marker, OpenLayers. Feature
 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
 move, OpenLayers. Geometry. Point
 moveTo
OpenLayers.IconOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
-
{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.
+
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
Constructor for features.
{Array(OpenLayers.Feature)} list of features in this tile
{String}
Instances of this class are not useful.
{DOMElement} The image element is appended to the frame.
-
{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
+
{OpenLayers.Geometry}
Creates a geometry object.
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
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.
{DOMElement}
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.
-
{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}
move: function(x,
y)
Moves a point in place
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.
Create a new MultiPoint Geometry
+
{Number} height
{OpenLayers.Handler} null
hide: function()
-
{Integer}
{Integer} Number of zoom levels for the map.
+
{OpenLayers.Icon}
Creates an icon, which is an image tag in a div.
{String}
{String} Unique identifier for the map
{String} null
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
{DOMElement}
{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.
-
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
The OpenLayers object provides a namespace for all things OpenLayers Classes in 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.
MultiPoint is a collection of Points.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
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.
+
{OpenLayers.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.
{OpenLayers.LonLat}
{OpenLayers.LonLat} location of object
{OpenLayers.LonLat}
Create a new OpenLayers.LonLat instance
-
Create a new OpenLayers.Pixel instance
Construct a point geometry.
Constructor for a Polygon geometry.
{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.
+
{OpenLayers.Map}
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
Constructor for a new OpenLayers.Map instance.
{OpenLayers.Marker}
{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}
move: function(x,
y)
Moves a point in place
moveTo: function (px)
move icon to passed in px.
moveTo: function (px)
Move the marker to the new location.
moveTo: function(px)
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
Create a new MultiPoint Geometry
-
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}
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
+
{Integer}
{Integer} Number of zoom levels for the map.
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General3.html b/index/General3.html index 9a91b8221a..c2a9beadda 100644 --- a/index/General3.html +++ b/index/General3.html @@ -8,34 +8,26 @@ 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
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
 toShortString, OpenLayers. Geometry. Point
 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. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
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
O
 offset, OpenLayers.Icon
 onclick, OpenLayers. Popup
 ondblclick, OpenLayers. Popup
 onmousedown, OpenLayers. Popup
 onmousemove, OpenLayers. Popup
 onmouseout, OpenLayers. Popup
 onmouseup, OpenLayers. Popup
 onScreen
OpenLayers. FeatureOpenLayers. Marker
 opacity, OpenLayers. Popup
 OpenLayers
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Feature
 OpenLayers. Feature. Vector
 OpenLayers. Feature.WFS
 OpenLayers. Format
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 OpenLayers.Icon
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Pixel
 OpenLayers. Popup
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
 OpenLayers/ Control.js
 oppositeQuadrant, OpenLayers. Bounds
P
 padding, OpenLayers. Popup
 Pixel, OpenLayers. Pixel. OpenLayers
 Point, OpenLayers. Geometry. Point. OpenLayers. Geometry
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 popup, OpenLayers. Feature
 Popup, OpenLayers. Popup. OpenLayers
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 processXMLNode, OpenLayers. Feature.WFS
 projection
OpenLayers. LayerOpenLayers.Map
 Properties
GlobalOpenLayersOpenLayers. BoundsOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. GeometryOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. MarkerOpenLayers. PixelOpenLayers. PopupOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 Properties and Functions, OpenLayers.Map
 px, OpenLayers.Icon
R
 read, OpenLayers. Format
 registerEvents, OpenLayers. Popup
 reproject, OpenLayers. Layer.WMS
 requestSuccess, OpenLayers. Tile.WFS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 setBackgroundColor, OpenLayers. Popup
 setBorder, OpenLayers. Popup
 setContentHTML, OpenLayers. Popup
 setOpacity
OpenLayers.IconOpenLayers. MarkerOpenLayers. Popup
 setOptions, OpenLayers.Map
 setSize
OpenLayers.IconOpenLayers. Popup
 show, OpenLayers. Popup
 size
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.MapOpenLayers. PopupOpenLayers.Tile
 Size, OpenLayers. Size. OpenLayers
 state, OpenLayers. Feature. Vector
 style
OpenLayers. Feature. VectorOpenLayers. Feature. Vector. OpenLayers. Feature. Vector
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
 toggle, OpenLayers. Popup
 top, OpenLayers. Bounds
 toShortString, OpenLayers. Geometry. Point
 toState, OpenLayers. Feature. Vector
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
-
{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}
toShortString: function()
{String} Shortened String representation of Point object.
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.
+
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
onclick: function (evt)
Ignore clicks, but allowing default browser handling
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
{float}
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.
Features are combinations of geography and attributes.
Vector features use the OpenLayers.Geometry classes as geometry description.
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
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.
MultiPoint is a collection of Points.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
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.
-
{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}
+
{int}
Create a new OpenLayers.Pixel instance
Construct a point geometry.
Constructor for a Polygon geometry.
{OpenLayers.Popup}
Create a popup.
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
{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.
{OpenLayers.Pixel}
-
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.
+
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
registerEvents:function()
Registers events on the popup.
{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}
-
{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.
+
{Array}
setBackgroundColor:function(color)
setBorder:function(border)
setContentHTML:function(contentHTML)
setOpacity: function(opacity)
Change the icon’s opacity
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOpacity:function(opacity)
setOptions: function(options)
Change the map options
setSize: function(size)
setSize:function(size)
show: function()
{OpenLayers.Size}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size}
{OpenLayers.Size} null
Create an instance of OpenLayers.Size
{String}
{Object}
OpenLayers features can have a number of style attributes.
-
{float}
{Number} The x coordinate
- - - -
{float}
- - - -
{Object} Base z-indexes for different classes of thing
{Integer} The current zoom level of the map
+
{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.
toggle: function()
{Number}
toShortString: function()
{String} Shortened String representation of Point object.
toState: function(state)
Sets the new state
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.
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General4.html b/index/General4.html new file mode 100644 index 0000000000..191d1795d4 --- /dev/null +++ b/index/General4.html @@ -0,0 +1,37 @@ + + +Index - 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
U
 units
OpenLayers. LayerOpenLayers.Map
 unloadDestroy, OpenLayers.Map
 updatePosition, OpenLayers. Popup
 url
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 Vector
OpenLayers. Feature. Vector. OpenLayers. FeatureOpenLayers. Layer. Vector. OpenLayers. Layer
 VERSION_NUMBER, OpenLayers
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
 visible, OpenLayers. Popup
W
 w, OpenLayers.Size
 warn, OpenLayers. Console
 WFS
OpenLayers. Feature. WFS. OpenLayers. FeatureOpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 wrapDateLine, OpenLayers. Layer
 write, OpenLayers. Format
X
 x
OpenLayers. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
Z
 Z_INDEX_BASE, OpenLayers.Map
 zoom, OpenLayers.Map
+ +
{String} The layer map units.
{String} The map units.
Function that is called to destroy the map on page unload.
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
{String} image url
{String} URL of the image to use
{String} url of the request
{String} The URL of the image being requested.
{String}
+ + + +
Create a vector feature.
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.
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
+ + + +
{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.
Create a WFS feature.
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.
+ + + +
{float}
{Number} The x coordinate
+ + + +
{float}
+ + + +
{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 5be2e1c04b..e793c650c3 100644 --- a/index/Properties.html +++ b/index/Properties.html @@ -8,98 +8,102 @@ 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
 active
 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
 handler
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. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
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
 active
 aspectRatio, OpenLayers. Layer. Image
 attributes, OpenLayers. Feature. Vector
B
 backgroundColor, OpenLayers. Popup
 baseLayer, OpenLayers.Map
 border, OpenLayers. Popup
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers.Tile
C
 calculateOffset, OpenLayers.Icon
 center, OpenLayers.Map
 contentDiv, OpenLayers. Popup
 contentHTML, OpenLayers. Popup
 controls, OpenLayers.Map
D
 data, OpenLayers. Feature
 displayOutsideMaxExtent, OpenLayers. Layer
 div
OpenLayers.MapOpenLayers. Popup
 drawn, OpenLayers.Tile
E
 events
OpenLayers. FeatureOpenLayers.MapOpenLayers. MarkerOpenLayers. Popup
 extent, OpenLayers. Layer. Image
F
 fallThrough, OpenLayers.Map
 features, OpenLayers. Tile.WFS
 fid, OpenLayers. Feature. Vector
 frame, OpenLayers. Tile. Image
G
 geometry, OpenLayers. Feature. Vector
 groupDiv, OpenLayers. Popup
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
 handler
I
 icon, OpenLayers. Marker
 id
OpenLayers. FeatureOpenLayers.MapOpenLayers.Tile
 imageDiv, OpenLayers.Icon
 imgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer
OpenLayers. FeatureOpenLayers.Tile
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 lonlat
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Popup
M
 map
OpenLayers. MarkerOpenLayers. Popup
 marker, OpenLayers. Feature
 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
O
 offset, OpenLayers.Icon
 opacity, OpenLayers. Popup
P
 padding, OpenLayers. Popup
 popup, OpenLayers. Feature
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
 px, OpenLayers.Icon
R
 reproject, OpenLayers. Layer.WMS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 size
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.MapOpenLayers. PopupOpenLayers.Tile
 state, OpenLayers. Feature. Vector
 style, OpenLayers. Feature. Vector
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 tileSize, OpenLayers.Map
 top, OpenLayers. Bounds
U
 units
OpenLayers. LayerOpenLayers.Map
 url
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 wrapDateLine, OpenLayers. Layer
X
 x
OpenLayers. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
Z
 zoom, OpenLayers.Map
{String} Relative path of this script.
-
{boolean} null
{Number} The ratio of height/width represented by a single pixel in the graphic
+
{boolean} null
{Number} The ratio of height/width represented by a single pixel in the graphic
{Object}
-
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
+
{String}
{String}
{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.Pixel} Function to calculate the offset (based on the size)
{OpenLayers.LonLat} The current center of the map
{DOMElement}
{String}
{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
+
{Object}
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
{DOMElement} The element that contains the map
{DOMElement}
{Boolean} false
-
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{OpenLayers.Bounds} The image bounds in map units
+
{OpenLayers.Events}
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{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
{String}
{DOMElement} The image element is appended to the frame.
-
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
+
{OpenLayers.Geometry}
{DOMElement}
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
-
{Number} height
{OpenLayers.Handler} null
+
{Number} height
{OpenLayers.Handler} null
-
{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.Icon}
{String}
{String} Unique identifier for the map
{String} null
{DOMElement}
{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.LonLat} location of object
+
{OpenLayers.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.LonLat}
{OpenLayers.LonLat} location of object
{OpenLayers.LonLat}
-
{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}
+
{OpenLayers.Map}
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
{OpenLayers.Marker}
{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.
+
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
{float}
-
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
{Array}
{Number}
+
{int}
{OpenLayers.Popup}
{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.
{OpenLayers.Pixel}
-
{Array}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size} null
+
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
{Array}
{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}
+
{Array}
{OpenLayers.Size}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size}
{OpenLayers.Size} null
{String}
{Object}
-
{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} 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}
-
{HTMLDivElement} The element that represents the map viewport
{String} Used to store a unique identifier that changes when the map view changes.
+
{String} The layer map units.
{String} The map units.
{String} image url
{String} URL of the image to use
{String} url of the request
{String} The URL of the image being requested.
{String}
-
{Number} width
{Boolean} #487 for more info.
+
{HTMLDivElement} The element that represents the map viewport
{String} Used to store a unique identifier that changes when the map view changes.
-
{float}
{Number} The x coordinate
+
{Number} width
{Boolean} #487 for more info.
-
{float}
+
{float}
{Number} The x coordinate
-
{Integer} The current zoom level of the map
+
{float}
+ + + +
{Integer} The current zoom level of the map
Generated by Natural Docs
\ No newline at end of file