From 14530c26219788c277ab9f3a0d30ddb77844a10f Mon Sep 17 00:00:00 2001 From: crschmidt Date: Thu, 21 Jun 2007 00:29:02 +0000 Subject: [PATCH] Generate More docs, new docs. git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3392 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf --- files/OpenLayers-js.html | 67 +++--- files/OpenLayers/BaseTypes-js.html | 183 ++++++++-------- files/OpenLayers/Console-js.html | 103 ++++----- files/OpenLayers/Control-js.html | 29 +++ files/OpenLayers/Format-js.html | 67 +++--- files/OpenLayers/Geometry-js.html | 59 ++--- files/OpenLayers/Geometry/Collection-js.html | 51 ++--- .../Geometry/MultiLineString-js.html | 59 ++--- files/OpenLayers/Geometry/MultiPoint-js.html | 27 +++ files/OpenLayers/Geometry/Point-js.html | 45 ++++ files/OpenLayers/Geometry/Polygon-js.html | 29 +++ files/OpenLayers/Layer-js.html | 119 +++++----- files/OpenLayers/Layer/Image-js.html | 95 ++++---- files/OpenLayers/Layer/Vector-js.html | 71 +++--- files/OpenLayers/Layer/WMS-js.html | 87 ++++---- files/OpenLayers/Map-js.html | 203 +++++++++--------- files/OpenLayers/Marker-js.html | 99 ++++----- files/OpenLayers/Tile-js.html | 103 ++++----- files/OpenLayers/Tile/Image-js.html | 91 ++++---- files/OpenLayers/Tile/WFS-js.html | 91 ++++---- index/Classes.html | 31 +-- index/Constants.html | 71 +++--- index/Files.html | 17 ++ index/Functions.html | 159 +++++++------- index/Functions2.html | 29 +++ index/General.html | 103 +++++---- index/General2.html | 103 ++++----- index/General3.html | 41 ++++ index/Properties.html | 203 +++++++++--------- styles/main.css | 4 +- 30 files changed, 1321 insertions(+), 1118 deletions(-) create mode 100644 files/OpenLayers/Control-js.html create mode 100644 files/OpenLayers/Geometry/MultiPoint-js.html create mode 100644 files/OpenLayers/Geometry/Point-js.html create mode 100644 files/OpenLayers/Geometry/Polygon-js.html create mode 100644 index/Files.html create mode 100644 index/Functions2.html create mode 100644 index/General3.html diff --git a/files/OpenLayers-js.html b/files/OpenLayers-js.html index 4ba3e8cd00..0a1cf430c5 100644 --- a/files/OpenLayers-js.html +++ b/files/OpenLayers-js.html @@ -1,34 +1,35 @@ - - -OpenLayers - - - - - - - - - - -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers

The OpenLayers object provides a namespace for all things OpenLayers

Summary
OpenLayers
The OpenLayers object provides a namespace for all things OpenLayers
Properties
_scriptName
{String} Relative path of this script.
Functions
_getScriptLocation
Return the path to this script.
Constants
VERSION_NUMBER
- -

Properties

- -

_scriptName

{String} Relative path of this script.

- -

Functions

- -

_getScriptLocation

_getScriptLocation: function ()

Return the path to this script.

Return

Path to this script

- -

Constants

- -

VERSION_NUMBER

- -
Generated by Natural Docs
- -
_getScriptLocation: function ()
Return the path to this script.
- - + + + + + + + + + + +
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
+ +

Properties

+ +

_scriptName

{String} Relative path of this script.

+ +

Functions

+ +

_getScriptLocation

_getScriptLocation: function ()

Return the path to this script.

Return

Path to this script

+ +

Constants

+ +

VERSION_NUMBER

+ +
Generated by Natural Docs
+ +
_getScriptLocation: function ()
Return the path to this script.
+ + \ No newline at end of file diff --git a/files/OpenLayers/BaseTypes-js.html b/files/OpenLayers/BaseTypes-js.html index 6d735dddcf..116e5d85d8 100644 --- a/files/OpenLayers/BaseTypes-js.html +++ b/files/OpenLayers/BaseTypes-js.html @@ -1,92 +1,93 @@ - - -OpenLayers.Class - OpenLayers - - - - - - - - - - -
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.
- -

Functions

- -

create

create: function()

Create an OpenLayers style class

Return

An OpenLayers class

- -

inherit

inherit: function ()

Inherit from one or more OpenLayers style classes

Parameters

classOne or more classes can be provided as arguments

Return

An object prototype

- -

OpenLayers. Pixel

This class represents a screen coordinate, in x and y coordinates

Summary
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
- -

Properties

- -

x

{Number} The x coordinate

- -

x

{Number} The x coordinate

- -

Functions

- -

OpenLayers. Pixel

Create a new OpenLayers.Pixel instance

Parameters

x{Number} The x coordinate
y{Number} The y coordinate

Return

An instance of OpenLayers.Pixel

- -

toString

toString:function()

Cast this object into a string

Return

{String} The string representation of Pixel. ex: “x=200.4,y=242.2”

- -

clone

clone:function()

Return a clone of this pixel object

Return

{OpenLayers.Pixel} A clone pixel

- -

equals

equals:function(px)

Determine whether one pixel is equivalent to another

Parameters

px{OpenLayers.Pixel}

Return

{Boolean} The point passed in as parameter is equal to this.  Note that if px passed in is null, returns false.

- -

OpenLayers.Size

Instances of this class represent a width/height pair

Summary
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
- -

Properties

- -

w

{Number} width

- -

h

{Number} height

- -

Functions

- -

OpenLayers.Size

Create an instance of OpenLayers.Size

Parameters

w{Number} width
h{Number} height
- -

toString

toString:function()

Return the string representation of a size object

Return

{String} The string representation of OpenLayers.Size object.  (ex.  <i>”w=55,h=66”</i>)

- -

clone

clone:function()

Create a clone of this size object

Return

{OpenLayers.Size} A new OpenLayers.Size object with the same w and h values

- -

OpenLayers. LonLat

This class represents a longitude and latitude pair

Summary
Functions
OpenLayers. LonLat
Create a new OpenLayers.LonLat instance
toString
Return a readable string version of the lonlat
- -

Functions

- -

OpenLayers. LonLat

Create a new OpenLayers.LonLat instance

Parameters

lon{Number} The lon coordinate
lat{Number} The lat coordinate

Return

An instance of OpenLayers.LonLat

- -

toString

toString:function()

Return a readable string version of the lonlat

Return

{String} String representation of OpenLayers.LonLat object.  (ex.  <i>”lon=5,lat=42”</i>)

- -

OpenLayers. Bounds

Instances of this class represent bounding boxes.  Data stored as left, bottom, right, top floats

Summary
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.
- -

Properties

- -

left

{Number}

- -

bottom

{Number}

- -

right

{Number}

- -

top

{Number}

- -

Functions

- -

OpenLayers. Bounds

Construct a new bounds object.

Parameters

left{Number} The left bounds of the box.  Note that for width calculations, this is assumed to be less than the right value.
bottom{Number} The bottom bounds of the box.  Note that for height calculations, this is assumed to be more than the top value.
right{Number} The right bounds.
top{Number} The top bounds.

Return

{OpenLayers.Bounds} A new bounds instance.

- -

clone

clone:function()

Create a cloned instance of this bounds.

Return

{OpenLayers.Bounds} A fresh copy of the bounds

- -

equals

equals:function(bounds)

Test a two bounds for equivalence

Parameters

bounds{OpenLayers.Bounds}

Return

{Boolean} The passed-in OpenLayers.Bounds object has the same left, right, top, bottom components as this.  Note that if bounds passed in is null, returns false.

- -

oppositeQuadrant

OpenLayers.Bounds.oppositeQuadrant = function(quadrant)

Get the opposite quadrant for a given quadrant string.

Parameters

quadrant{String} two character quadrant shortstring

Return

{String} The opposing quadrant (“br” “tr” “tl” “bl”).  For Example, if you pass in “bl” it returns “tr”, if you pass in “br” it returns “tl”, etc.

- -
Generated by Natural Docs
- -
create: function()
Create an OpenLayers style class
inherit: function ()
Inherit from one or more OpenLayers style classes
toString:function()
Cast this object into a string
clone:function()
Return a clone of this pixel object
equals:function(px)
Determine whether one pixel is equivalent to another
toString:function()
Return the string representation of a size object
clone:function()
Create a clone of this size object
toString:function()
Return a readable string version of the lonlat
clone:function()
Create a cloned instance of this bounds.
equals:function(bounds)
Test a two bounds for equivalence
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
Construct a new bounds object.
- - + + + + + + + + + + +
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.
+ +

Functions

+ +

create

create: function()

Create an OpenLayers style class

Return

An OpenLayers class

+ +

inherit

inherit: function ()

Inherit from one or more OpenLayers style classes

Parameters

classOne or more classes can be provided as arguments

Return

An object prototype

+ +

OpenLayers. Pixel

This class represents a screen coordinate, in x and y coordinates

Summary
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
+ +

Properties

+ +

x

{Number} The x coordinate

+ +

x

{Number} The x coordinate

+ +

Functions

+ +

OpenLayers. Pixel

Create a new OpenLayers.Pixel instance

Parameters

x{Number} The x coordinate
y{Number} The y coordinate

Return

An instance of OpenLayers.Pixel

+ +

toString

toString:function()

Cast this object into a string

Return

{String} The string representation of Pixel. ex: “x=200.4,y=242.2”

+ +

clone

clone:function()

Return a clone of this pixel object

Return

{OpenLayers.Pixel} A clone pixel

+ +

equals

equals:function(px)

Determine whether one pixel is equivalent to another

Parameters

px{OpenLayers.Pixel}

Return

{Boolean} The point passed in as parameter is equal to this.  Note that if px passed in is null, returns false.

+ +

OpenLayers.Size

Instances of this class represent a width/height pair

Summary
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
+ +

Properties

+ +

w

{Number} width

+ +

h

{Number} height

+ +

Functions

+ +

OpenLayers.Size

Create an instance of OpenLayers.Size

Parameters

w{Number} width
h{Number} height
+ +

toString

toString:function()

Return the string representation of a size object

Return

{String} The string representation of OpenLayers.Size object.  (ex.  <i>”w=55,h=66”</i>)

+ +

clone

clone:function()

Create a clone of this size object

Return

{OpenLayers.Size} A new OpenLayers.Size object with the same w and h values

+ +

OpenLayers. LonLat

This class represents a longitude and latitude pair

Summary
Functions
OpenLayers. LonLat
Create a new OpenLayers.LonLat instance
toString
Return a readable string version of the lonlat
+ +

Functions

+ +

OpenLayers. LonLat

Create a new OpenLayers.LonLat instance

Parameters

lon{Number} The lon coordinate
lat{Number} The lat coordinate

Return

An instance of OpenLayers.LonLat

+ +

toString

toString:function()

Return a readable string version of the lonlat

Return

{String} String representation of OpenLayers.LonLat object.  (ex.  <i>”lon=5,lat=42”</i>)

+ +

OpenLayers. Bounds

Instances of this class represent bounding boxes.  Data stored as left, bottom, right, top floats

Summary
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.
+ +

Properties

+ +

left

{Number}

+ +

bottom

{Number}

+ +

right

{Number}

+ +

top

{Number}

+ +

Functions

+ +

OpenLayers. Bounds

Construct a new bounds object.

Parameters

left{Number} The left bounds of the box.  Note that for width calculations, this is assumed to be less than the right value.
bottom{Number} The bottom bounds of the box.  Note that for height calculations, this is assumed to be more than the top value.
right{Number} The right bounds.
top{Number} The top bounds.

Return

{OpenLayers.Bounds} A new bounds instance.

+ +

clone

clone:function()

Create a cloned instance of this bounds.

Return

{OpenLayers.Bounds} A fresh copy of the bounds

+ +

equals

equals:function(bounds)

Test a two bounds for equivalence

Parameters

bounds{OpenLayers.Bounds}

Return

{Boolean} The passed-in OpenLayers.Bounds object has the same left, right, top, bottom components as this.  Note that if bounds passed in is null, returns false.

+ +

oppositeQuadrant

OpenLayers.Bounds.oppositeQuadrant = function(quadrant)

Get the opposite quadrant for a given quadrant string.

Parameters

quadrant{String} two character quadrant shortstring

Return

{String} The opposing quadrant (“br” “tr” “tl” “bl”).  For Example, if you pass in “bl” it returns “tr”, if you pass in “br” it returns “tl”, etc.

+ +
Generated by Natural Docs
+ +
create: function()
Create an OpenLayers style class
inherit: function ()
Inherit from one or more OpenLayers style classes
toString:function()
Cast this object into a string
clone:function()
Return a clone of this pixel object
equals:function(px)
Determine whether one pixel is equivalent to another
toString:function()
Return the string representation of a size object
clone:function()
Create a clone of this size object
toString:function()
Return a readable string version of the lonlat
clone:function()
Create a cloned instance of this bounds.
equals:function(bounds)
Test a two bounds for equivalence
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
Construct a new bounds object.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Console-js.html b/files/OpenLayers/Console-js.html index 99687ca8ad..ef97b6876d 100644 --- a/files/OpenLayers/Console-js.html +++ b/files/OpenLayers/Console-js.html @@ -1,52 +1,53 @@ - - -OpenLayers.Console - OpenLayers - - - - - - - - - - -
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
- -

Functions

- -

log

log: function()

Log an object in the console.  The Firebug Lite console logs string representation of objects.  Given multiple arguments, they will be cast to strings and logged with a space delimiter.  If the first argument is a string with printf-like formatting, subsequent arguments will be used in string substitution.  Any additional arguments (beyond the number substituted in a format string) will be appended in a space- delimited line.

Examples

// Firebug Lite logs someObject.toString()
OpenLayers.Console.log(someObject);

// string substitution
OpenLayers.Console.log("%s jumped over %s", cow, moon);

Parameters

object{Object}
- -

debug

debug: function()

Writes a message to the console, including a hyperlink to the line where it was called.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
- -

info

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.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
- -

warn

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.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
- -

error

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.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
- -

assert

assert: function()

Tests that an expression is true.  If not, it will write a message to the console and throw an exception.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
- -

dir

dir: function()

Prints an interactive listing of all properties of the object.  This looks identical to the view that you would see in the DOM tab.

Parameters

object{Object}
- -

dirxml

dirxml: function()

Prints the XML source tree of an HTML or XML element.  This looks identical to the view that you would see in the HTML tab.  You can click on any node to inspect it in the HTML tab.

Parameters

object{Object}
- -

trace

trace: function()

Prints an interactive stack trace of JavaScript execution at the point where it is called.  The stack trace details the functions on the stack, as well as the values that were passed as arguments to each function.  You can click each function to take you to its source in the Script tab, and click each argument value to inspect it in the DOM or HTML tabs.

- -

group

group: function()

Writes a message to the console and opens a nested block to indent all future messages sent to the console.  Call OpenLayers.Console.groupEnd() to close the block.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
- -

groupEnd

groupEnd: function()

Closes the most recently opened block created by a call to OpenLayers.Console.group

- -

time

time: function()

Creates a new timer under the given name.  Call OpenLayers.Console.timeEnd(name) with the same name to stop the timer and print the time elapsed.

Parameters

name{String}
- -

Constants

- -

CLASS_NAME

- -
Generated by Natural Docs
- -
log: function()
Log an object in the console.
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
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.
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.
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.
assert: function()
Tests that an expression is true.
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.
trace: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
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
time: function()
Creates a new timer under the given name.
- - + + + + + + + + + + +
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
+ +

Functions

+ +

log

log: function()

Log an object in the console.  The Firebug Lite console logs string representation of objects.  Given multiple arguments, they will be cast to strings and logged with a space delimiter.  If the first argument is a string with printf-like formatting, subsequent arguments will be used in string substitution.  Any additional arguments (beyond the number substituted in a format string) will be appended in a space- delimited line.

Examples

// Firebug Lite logs someObject.toString()
OpenLayers.Console.log(someObject);

// string substitution
OpenLayers.Console.log("%s jumped over %s", cow, moon);

Parameters

object{Object}
+ +

debug

debug: function()

Writes a message to the console, including a hyperlink to the line where it was called.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
+ +

info

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.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
+ +

warn

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.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
+ +

error

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.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
+ +

assert

assert: function()

Tests that an expression is true.  If not, it will write a message to the console and throw an exception.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
+ +

dir

dir: function()

Prints an interactive listing of all properties of the object.  This looks identical to the view that you would see in the DOM tab.

Parameters

object{Object}
+ +

dirxml

dirxml: function()

Prints the XML source tree of an HTML or XML element.  This looks identical to the view that you would see in the HTML tab.  You can click on any node to inspect it in the HTML tab.

Parameters

object{Object}
+ +

trace

trace: function()

Prints an interactive stack trace of JavaScript execution at the point where it is called.  The stack trace details the functions on the stack, as well as the values that were passed as arguments to each function.  You can click each function to take you to its source in the Script tab, and click each argument value to inspect it in the DOM or HTML tabs.

+ +

group

group: function()

Writes a message to the console and opens a nested block to indent all future messages sent to the console.  Call OpenLayers.Console.groupEnd() to close the block.

May be called with multiple arguments as with OpenLayers.Console.log().

Parameters

object{Object}
+ +

groupEnd

groupEnd: function()

Closes the most recently opened block created by a call to OpenLayers.Console.group

+ +

time

time: function()

Creates a new timer under the given name.  Call OpenLayers.Console.timeEnd(name) with the same name to stop the timer and print the time elapsed.

Parameters

name{String}
+ +

Constants

+ +

CLASS_NAME

+ +
Generated by Natural Docs
+ +
log: function()
Log an object in the console.
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
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.
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.
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.
assert: function()
Tests that an expression is true.
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.
trace: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
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
time: function()
Creates a new timer under the given name.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Control-js.html b/files/OpenLayers/Control-js.html new file mode 100644 index 0000000000..9efc0f99d4 --- /dev/null +++ b/files/OpenLayers/Control-js.html @@ -0,0 +1,29 @@ + + +/Users/crschmidt/naturaldocs/lib/OpenLayers/Control.js - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers/ Control.js

Summary
OpenLayers/ Control.js
Properties
active
{boolean} null
handler
{<OpenLayers.Handler}> null
+ +

Properties

+ +

active

{boolean} null

+ +

handler

{<OpenLayers.Handler}> null

+ +
Generated by Natural Docs
+ + + + \ No newline at end of file diff --git a/files/OpenLayers/Format-js.html b/files/OpenLayers/Format-js.html index 7276621a1e..0987783903 100644 --- a/files/OpenLayers/Format-js.html +++ b/files/OpenLayers/Format-js.html @@ -1,34 +1,35 @@ - - -OpenLayers.Format - OpenLayers - - - - - - - - - - -
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
- -

Functions

- -

OpenLayers. Format

Instances of this class are not useful.  See one of the subclasses.

Parameters

options{Object} An optional object with properties to set on the format

Return

An instance of OpenLayers.Format

- -

read

read: function(data)

Read data from a string, and return an object whose type depends on the subclass.

Parameters

data{string} Data to read/parse.

Return

Depends on the subclass

- -

write

write: function(object)

Accept an object, and return a string.

Parameters

object{Object} Object to be serialized

Return

{String} A string representation of the object.

- -

Constants

- -

CLASS_NAME

{String} OpenLayers.Format

- -
Generated by Natural Docs
- -
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
write: function(object)
Accept an object, and return a string.
- - + + + + + + + + + + +
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
+ +

Functions

+ +

OpenLayers. Format

Instances of this class are not useful.  See one of the subclasses.

Parameters

options{Object} An optional object with properties to set on the format

Return

An instance of OpenLayers.Format

+ +

read

read: function(data)

Read data from a string, and return an object whose type depends on the subclass.

Parameters

data{string} Data to read/parse.

Return

Depends on the subclass

+ +

write

write: function(object)

Accept an object, and return a string.

Parameters

object{Object} Object to be serialized

Return

{String} A string representation of the object.

+ +

Constants

+ +

CLASS_NAME

{String} OpenLayers.Format

+ +
Generated by Natural Docs
+ +
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
write: function(object)
Accept an object, and return a string.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry-js.html b/files/OpenLayers/Geometry-js.html index 10e5413f5b..9f842f7ab8 100644 --- a/files/OpenLayers/Geometry-js.html +++ b/files/OpenLayers/Geometry-js.html @@ -1,30 +1,31 @@ - - -OpenLayers.Geometry - OpenLayers - - - - - - - - - - -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry

A Geometry is a description of a geographic object.

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

Properties

- -

bounds

{OpenLayers.Bounds}

- -

Functions

- -

OpenLayers. Geometry

Creates a geometry object.

Returns

{OpenLayers.Geometry} geometry.

- -
Generated by Natural Docs
- -
Instances of this class represent bounding boxes.
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry

A Geometry is a description of a geographic object.

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

Properties

+ +

bounds

{OpenLayers.Bounds}

+ +

Functions

+ +

OpenLayers. Geometry

Creates a geometry object.

Returns

{OpenLayers.Geometry} geometry.

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

OpenLayers. Geometry. Collection

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

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

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

Inerhits from

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

Functions

- -

OpenLayers. Geometry. Collection

Creates a Geometry Collection -- a list of geoms.

Parameters

components{Array(OpenLayers.Geometry)}

Returns

{OpenLayers.Geometry.Collection}

- -
Generated by Natural Docs
- -
A Geometry is a description of a geographic object.
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. Collection

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

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

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

Inerhits from

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

Functions

+ +

OpenLayers. Geometry. Collection

Creates a Geometry Collection -- a list of geoms.

Parameters

components{Array(OpenLayers.Geometry)}

Returns

{OpenLayers.Geometry.Collection}

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

OpenLayers. Geometry. MultiLineString

A MultiLineString is a collection of LineStrings.

Inherits from

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

Functions

- -

OpenLayers. Geometry. MultiLineString

Constructor for a MultiLineString Geometry.

Parameters

components{Array(OpenLayers.Geometry.LineString)}

Return

OpenLayers.Geometry.MultiLineString object.

- -

Constants

- -

CLASS_NAME

Name of class.

- -
Generated by Natural Docs
- -
A Collection is exactly what it sounds like: A collection of different Geometries.
A Geometry is a description of a geographic object.
Constructor for a MultiLineString Geometry.
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. MultiLineString

A MultiLineString is a collection of LineStrings.

Inherits from

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

Functions

+ +

OpenLayers. Geometry. MultiLineString

Constructor for a MultiLineString Geometry.

Parameters

components{Array(OpenLayers.Geometry.LineString)}

Return

OpenLayers.Geometry.MultiLineString object.

+ +

Constants

+ +

CLASS_NAME

Name of class.

+ +
Generated by Natural Docs
+ +
A Collection is exactly what it sounds like: A collection of different Geometries.
A Geometry is a description of a geographic object.
Constructor for a MultiLineString Geometry.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/MultiPoint-js.html b/files/OpenLayers/Geometry/MultiPoint-js.html new file mode 100644 index 0000000000..c32d197f16 --- /dev/null +++ b/files/OpenLayers/Geometry/MultiPoint-js.html @@ -0,0 +1,27 @@ + + +OpenLayers.Geometry.MultiPoint - OpenLayers + + + + + + + + + + +
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
+ +

Functions

+ +

OpenLayers. Geometry. MultiPoint

Create a new MultiPoint Geometry

Parameters

componentsArray({OpenLayers.Geometry.Point})

Return

{OpenLayers.Geometry.MultiPoint}

+ +
Generated by Natural Docs
+ +
A Collection is exactly what it sounds like: A collection of different Geometries.
A Geometry is a description of a geographic object.
Point geometry class.
Create a new MultiPoint Geometry
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/Point-js.html b/files/OpenLayers/Geometry/Point-js.html new file mode 100644 index 0000000000..ac8b10ca04 --- /dev/null +++ b/files/OpenLayers/Geometry/Point-js.html @@ -0,0 +1,45 @@ + + +OpenLayers.Geometry.Point - OpenLayers + + + + + + + + + + +
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
+ +

Properties

+ +

x

{float}

+ +

y

{float}

+ +

Functions

+ +

OpenLayers. Geometry. Point

Construct a point geometry.

Parameters

x{float}
y{float}

Return

{OpenLayers.Geometry.Point}

+ +

clone

clone: function(obj)

Return

{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point

+ +

calculateBounds

calculateBounds: function ()

Create a new Bounds based on the lon/lat

+ +

distanceTo

distanceTo: function(point)

Parameters

point{OpenLayers.Geometry.Point}
+ +

equals

equals:function(geom)

Parameters

xy{OpenLayers.Geometry}

Return

{Boolean} Boolean value indicating whether the passed-in {OpenLayers.Geometry} object has the same components as this note that if ll passed in is null, returns false

+ +

toShortString

toShortString: function()

Return

{String} Shortened String representation of Point object.  (ex.  <i>”5, 42”</i>)

+ +

move

move: function(x,
y)

Moves a point in place

Parameters

x{Float}
y{Float}
+ +
Generated by Natural Docs
+ +
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
Construct a point geometry.
calculateBounds: function ()
Create a new Bounds based on the lon/lat
distanceTo: function(point)
equals:function(geom)
toShortString: function()
{String} Shortened String representation of Point object.
move: function(x,
y)
Moves a point in place
A Geometry is a description of a geographic object.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/Polygon-js.html b/files/OpenLayers/Geometry/Polygon-js.html new file mode 100644 index 0000000000..b2f0a9a3b3 --- /dev/null +++ b/files/OpenLayers/Geometry/Polygon-js.html @@ -0,0 +1,29 @@ + + +OpenLayers.Geometry.Polygon - OpenLayers + + + + + + + + + + +
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.
+ +

Functions

+ +

OpenLayers. Geometry. Polygon

Constructor for a Polygon geometry.  The first ring (this.component[0])is the outer bounds of the polygon and all subsequent rings (this.component[1-n]) are internal holes.

Parameters

componentsArray({<OpenLayers.Geometry.LinearRing>})

Return

{OpenLayers.Geometry.Polygon}

+ +

getArea

getArea: function()

Calculated by subtracting the areas of the internal holes from the area of the outer hole.

Return

{float} The area of the geometry

+ +
Generated by Natural Docs
+ +
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
A Collection is exactly what it sounds like: A collection of different Geometries.
A Geometry is a description of a geographic object.
Constructor for a Polygon geometry.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer-js.html b/files/OpenLayers/Layer-js.html index 9ffe8609a8..890a362b4e 100644 --- a/files/OpenLayers/Layer-js.html +++ b/files/OpenLayers/Layer-js.html @@ -1,60 +1,61 @@ - - -OpenLayers.Layer - OpenLayers - - - - - - - - - - -
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
- -

Properties

- -

gutter

{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.  By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter.  This allows artifacts of rendering at tile edges to be ignored.  Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed.  Defaults to zero.  Non-tiled layers always have zero gutter.

- -

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.  Defaults to ‘degrees’.  Possible values are ‘degrees’ (or ‘dd’), ‘m’, ‘ft’, ‘km’, ‘mi’, ‘inches’.

- -

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.  Specify a different value in the layer options if you are not using a geographic projection and displaying the whole world.

- -

minResolution

{Number}

- -

numZoomLevels

{Integer}

- -

minScale

{Number}

- -

maxScale

{Number}

- -

displayOutsideMaxExtent

{Boolean} Request map tiles that are completely outside of the max extent for this layer.  Defaults to false

- -

wrapDateLine

{Boolean} #487 for more info.

- -

Functions

- -

OpenLayers. Layer

Parameters

name{String} The layer name
options{Object} Hashtable of extra options to tag onto the layer

Return

An instance of OpenLayers.Layer

- -

destroy

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.

Parameters

setNewBaseLayer{Boolean} Should a new baselayer be selected when this has been removed?  Default is true.
- -

clone

clone: function (obj)

Parameters

obj{OpenLayers.Layer} The layer to be cloned

Return

{OpenLayers.Layer} An exact clone of this OpenLayers.Layer

- -
Generated by Natural Docs
- -
Instances of this class represent bounding boxes.
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.
clone: function (obj)
- - + + + + + + + + + + +
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
+ +

Properties

+ +

gutter

{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.  By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter.  This allows artifacts of rendering at tile edges to be ignored.  Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed.  Defaults to zero.  Non-tiled layers always have zero gutter.

+ +

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.  Defaults to ‘degrees’.  Possible values are ‘degrees’ (or ‘dd’), ‘m’, ‘ft’, ‘km’, ‘mi’, ‘inches’.

+ +

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.  Specify a different value in the layer options if you are not using a geographic projection and displaying the whole world.

+ +

minResolution

{Number}

+ +

numZoomLevels

{Integer}

+ +

minScale

{Number}

+ +

maxScale

{Number}

+ +

displayOutsideMaxExtent

{Boolean} Request map tiles that are completely outside of the max extent for this layer.  Defaults to false

+ +

wrapDateLine

{Boolean} #487 for more info.

+ +

Functions

+ +

OpenLayers. Layer

Parameters

name{String} The layer name
options{Object} Hashtable of extra options to tag onto the layer

Return

An instance of OpenLayers.Layer

+ +

destroy

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.

Parameters

setNewBaseLayer{Boolean} Should a new baselayer be selected when this has been removed?  Default is true.
+ +

clone

clone: function (obj)

Parameters

obj{OpenLayers.Layer} The layer to be cloned

Return

{OpenLayers.Layer} An exact clone of this OpenLayers.Layer

+ +
Generated by Natural Docs
+ +
Instances of this class represent bounding boxes.
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.
clone: function (obj)
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer/Image-js.html b/files/OpenLayers/Layer/Image-js.html index bf5028b6c1..92bd4fa68d 100644 --- a/files/OpenLayers/Layer/Image-js.html +++ b/files/OpenLayers/Layer/Image-js.html @@ -1,48 +1,49 @@ - - -OpenLayers.Layer.Image - OpenLayers - - - - - - - - - - -
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
- -

Properties

- -

isBaseLayer

{Boolean} The layer is a base layer.  Default is true.  Set this property in the layer options

- -

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

Parameters

name{String} A name for the layer.
url{String} Relative or absolute path to the image
extent{OpenLayers.Bounds} The extent represented by the image
size{OpenLayers.Size} The size (in pixels) of the image
options{Object} Hashtable of extra options to tag onto the layer
- -

destroy

destroy: function()

Destroy this layer

- -

clone

clone: function(obj)

Create a clone of this layer

Paramters

obj{Object} An optional layer (is this ever used?)

Return

{OpenLayers.Layer.Image} An exact copy of this layer

- -

Constants

- -

CLASS_NAME

{String} OpenLayers.Layer.Image

- -
Generated by Natural Docs
- -
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
destroy: function()
Destroy this layer
clone: function(obj)
Create a clone of this layer
Create a new image layer
- - + + + + + + + + + + +
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
+ +

Properties

+ +

isBaseLayer

{Boolean} The layer is a base layer.  Default is true.  Set this property in the layer options

+ +

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

Parameters

name{String} A name for the layer.
url{String} Relative or absolute path to the image
extent{OpenLayers.Bounds} The extent represented by the image
size{OpenLayers.Size} The size (in pixels) of the image
options{Object} Hashtable of extra options to tag onto the layer
+ +

destroy

destroy: function()

Destroy this layer

+ +

clone

clone: function(obj)

Create a clone of this layer

Paramters

obj{Object} An optional layer (is this ever used?)

Return

{OpenLayers.Layer.Image} An exact copy of this layer

+ +

Constants

+ +

CLASS_NAME

{String} OpenLayers.Layer.Image

+ +
Generated by Natural Docs
+ +
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
destroy: function()
Destroy this layer
clone: function(obj)
Create a clone of this layer
Create a new image layer
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer/Vector-js.html b/files/OpenLayers/Layer/Vector-js.html index 6620d13226..fd87cc2779 100644 --- a/files/OpenLayers/Layer/Vector-js.html +++ b/files/OpenLayers/Layer/Vector-js.html @@ -1,36 +1,37 @@ - - -OpenLayers.Layer.Vector - OpenLayers - - - - - - - - - - -
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
- -

Properties

- -

isBaseLayer

{Boolean} The layer is a base layer.  Default is true.  Set this property in the layer options

- -

Functions

- -

OpenLayers. Layer. Vector

Create a new vector layer

Parameters

name{String} A name for the layer
options{Object} options Object with non-default properties to set on the layer.

Return

{OpenLayers.Layer.Vector} A new vector layer

- -

destroy

destroy: function()

Destroy this layer

- -

Constants

- -

CLASS_NAME

{String} OpenLayers.Layer.Vector

- -
Generated by Natural Docs
- -
destroy: function()
Destroy this layer
Create a new vector layer
- - + + + + + + + + + + +
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
+ +

Properties

+ +

isBaseLayer

{Boolean} The layer is a base layer.  Default is true.  Set this property in the layer options

+ +

Functions

+ +

OpenLayers. Layer. Vector

Create a new vector layer

Parameters

name{String} A name for the layer
options{Object} options Object with non-default properties to set on the layer.

Return

{OpenLayers.Layer.Vector} A new vector layer

+ +

destroy

destroy: function()

Destroy this layer

+ +

Constants

+ +

CLASS_NAME

{String} OpenLayers.Layer.Vector

+ +
Generated by Natural Docs
+ +
destroy: function()
Destroy this layer
Create a new vector layer
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer/WMS-js.html b/files/OpenLayers/Layer/WMS-js.html index af441ff72d..88375afc7a 100644 --- a/files/OpenLayers/Layer/WMS-js.html +++ b/files/OpenLayers/Layer/WMS-js.html @@ -1,44 +1,45 @@ - - -OpenLayers.Layer.WMS - OpenLayers - - - - - - - - - - -
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
- -

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.  Default is true.  Set this in the layer options.  Should be set to false in most cases.

- -

Functions

- -

OpenLayers. Layer.WMS

Create a new WMS layer object

Example

var wms = new OpenLayers.Layer.WMS("NASA Global Mosaic",
                                   "http://wms.jpl.nasa.gov/wms.cgi",
                                   {layers: "modis,global_mosaic"});

Parameters

name{String} A name for the layer
url{String} Base url for the WMS (e.g.  http://wms.jpl.nasa.gov/wms.cgi)
params{Object} An object with key/value pairs representing the GetMap query string parameters and parameter values.
options{Ojbect} Hashtable of extra options to tag onto the layer

Return

A new OpenLayers.Layer.WMS instance

- -

destroy

destroy: function()

Destroy this layer

- -

clone

clone: function (obj)

Create a clone of this layer

Return

{OpenLayers.Layer.WMS} An exact clone of this layer

- -

getURL

getURL: function (bounds)

Return a GetMap query string for this layer

Parameters

bounds{OpenLayers.Bounds} A bounds representing the bbox for the request

Return

{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters

- -

Constants

- -

CLASS_NAME

{String} OpenLayers.Layer.WMS

- -
Generated by Natural Docs
- -
destroy: function()
Destroy this layer
clone: function (obj)
Create a clone of this layer
getURL: function (bounds)
Return a GetMap query string for this layer
Create a new WMS layer object
Instances of this class represent bounding boxes.
- - + + + + + + + + + + +
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
+ +

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.  Default is true.  Set this in the layer options.  Should be set to false in most cases.

+ +

Functions

+ +

OpenLayers. Layer.WMS

Create a new WMS layer object

Example

var wms = new OpenLayers.Layer.WMS("NASA Global Mosaic",
                                   "http://wms.jpl.nasa.gov/wms.cgi",
                                   {layers: "modis,global_mosaic"});

Parameters

name{String} A name for the layer
url{String} Base url for the WMS (e.g.  http://wms.jpl.nasa.gov/wms.cgi)
params{Object} An object with key/value pairs representing the GetMap query string parameters and parameter values.
options{Ojbect} Hashtable of extra options to tag onto the layer

Return

A new OpenLayers.Layer.WMS instance

+ +

destroy

destroy: function()

Destroy this layer

+ +

clone

clone: function (obj)

Create a clone of this layer

Return

{OpenLayers.Layer.WMS} An exact clone of this layer

+ +

getURL

getURL: function (bounds)

Return a GetMap query string for this layer

Parameters

bounds{OpenLayers.Bounds} A bounds representing the bbox for the request

Return

{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters

+ +

Constants

+ +

CLASS_NAME

{String} OpenLayers.Layer.WMS

+ +
Generated by Natural Docs
+ +
destroy: function()
Destroy this layer
clone: function (obj)
Create a clone of this layer
getURL: function (bounds)
Return a GetMap query string for this layer
Create a new WMS layer object
Instances of this class represent bounding boxes.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Map-js.html b/files/OpenLayers/Map-js.html index 4923d7a4a4..0d31c0ccfd 100644 --- a/files/OpenLayers/Map-js.html +++ b/files/OpenLayers/Map-js.html @@ -1,102 +1,103 @@ - - -OpenLayers.Map - OpenLayers - - - - - - - - - - -
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
- -

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. stored here so that if map is manually destroyed, we can unregister this.

- -

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

{<OpenLayers.Layer>} The currently selected base layerthis determines min/max zoom level, projection, etc.
- -

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. viewRequestID should be used when adding data asynchronously to the map: viewRequestID is incremented when you initiate your request (right now during changing of baselayers and changing of zooms).  It is stored here in the map and also in the data that will be coming back asynchronously.  Before displaying this data on request completion, we check that the viewRequestID of the data is still the same as that of the map.  Fix for #480

- -

tileSize

{OpenLayers.Size} Set in the map options to override the default tile size for this map.

- -

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.  Defaults to ‘degrees’.  Possible values are ‘degrees’ (or ‘dd’), ‘m’, ‘ft’, ‘km’, ‘mi’, ‘inches’.

- -

maxResolution

{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.  Specify a different value in the map options if you are not using a geographic projection and displaying the whole world.

- -

minResolution

{Number}

- -

maxScale

{Number}

- -

minScale

- -

maxExtent

{OpenLayers.Bounds} The maximum extent for the map.  Defaults to the whole world in decimal degrees (-180, -90, 180, 90).  Specify a different extent in the map options if you are not using a geographic projection and displaying the whole world.

- -

minExtent

{OpenLayers.Bounds}

- -

numZoomLevels

{Integer} Number of zoom levels for the map.  Defaults to 16.  Set a different value in the map options if needed.

- -

theme

{String} Relative path to a CSS file from which to load theme styles.  Specify null in the map options (e.g.  {theme: null}) if you want to get cascading style declarations - by putting links to stylesheets or style declarations directly in your page.

- -

fallThrough

{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them?  (#457) Default is to swallow them.

- -

OpenLayers.Map

Constructor for a new OpenLayers.Map instance.

Parameters

div{String} The id of an element in your page that will contain the map
options{Object} An optional object with properties to tag onto the map

Examples

// create a map with default options in an element with the id "map1"
var map = new OpenLayers.Map("map1");

// create a map with non-default options in an element with id "map2"
var options = {
    maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
    maxResolution: 156543,
    units: 'meters',
    projection: "EPSG:41001"
};
var map = new OpenLayers.Map("map2", options);

Return

A new OpenLayers.Map instance

- -

destroy

destroy:function()

Destroy this map

- -

setOptions

setOptions: function(options)

Change the map options

Parameters

options{Object} Hashtable of options to tag to the map
- -

getTileSize

getTileSize: function()

Get the tile size for the map

Return

{OpenLayers.Size}

- -

getLayer

getLayer: function(id)

Get a layer based on its id

Parameter

id{String} A layer id

Return

{OpenLayers.Layer} The Layer with the corresponding id from the map’s layer collection, or null if not found.

- -

Constants

- -

CLASS_NAME

{String} OpenLayers.Map

- -
Generated by Natural Docs
- -
Instances of this class represent a width/height pair
This class represents a longitude and latitude pair
Instances of this class represent bounding boxes.
destroy:function()
Destroy this map
setOptions: function(options)
Change the map options
getTileSize: function()
Get the tile size for the map
getLayer: function(id)
Get a layer based on its id
Constructor for a new OpenLayers.Map instance.
- - + + + + + + + + + + +
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
+ +

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. stored here so that if map is manually destroyed, we can unregister this.

+ +

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

{<OpenLayers.Layer>} The currently selected base layerthis determines min/max zoom level, projection, etc.
+ +

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. viewRequestID should be used when adding data asynchronously to the map: viewRequestID is incremented when you initiate your request (right now during changing of baselayers and changing of zooms).  It is stored here in the map and also in the data that will be coming back asynchronously.  Before displaying this data on request completion, we check that the viewRequestID of the data is still the same as that of the map.  Fix for #480

+ +

tileSize

{OpenLayers.Size} Set in the map options to override the default tile size for this map.

+ +

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.  Defaults to ‘degrees’.  Possible values are ‘degrees’ (or ‘dd’), ‘m’, ‘ft’, ‘km’, ‘mi’, ‘inches’.

+ +

maxResolution

{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.  Specify a different value in the map options if you are not using a geographic projection and displaying the whole world.

+ +

minResolution

{Number}

+ +

maxScale

{Number}

+ +

minScale

+ +

maxExtent

{OpenLayers.Bounds} The maximum extent for the map.  Defaults to the whole world in decimal degrees (-180, -90, 180, 90).  Specify a different extent in the map options if you are not using a geographic projection and displaying the whole world.

+ +

minExtent

{OpenLayers.Bounds}

+ +

numZoomLevels

{Integer} Number of zoom levels for the map.  Defaults to 16.  Set a different value in the map options if needed.

+ +

theme

{String} Relative path to a CSS file from which to load theme styles.  Specify null in the map options (e.g.  {theme: null}) if you want to get cascading style declarations - by putting links to stylesheets or style declarations directly in your page.

+ +

fallThrough

{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them?  (#457) Default is to swallow them.

+ +

OpenLayers.Map

Constructor for a new OpenLayers.Map instance.

Parameters

div{String} The id of an element in your page that will contain the map
options{Object} An optional object with properties to tag onto the map

Examples

// create a map with default options in an element with the id "map1"
var map = new OpenLayers.Map("map1");

// create a map with non-default options in an element with id "map2"
var options = {
    maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
    maxResolution: 156543,
    units: 'meters',
    projection: "EPSG:41001"
};
var map = new OpenLayers.Map("map2", options);

Return

A new OpenLayers.Map instance

+ +

destroy

destroy:function()

Destroy this map

+ +

setOptions

setOptions: function(options)

Change the map options

Parameters

options{Object} Hashtable of options to tag to the map
+ +

getTileSize

getTileSize: function()

Get the tile size for the map

Return

{OpenLayers.Size}

+ +

getLayer

getLayer: function(id)

Get a layer based on its id

Parameter

id{String} A layer id

Return

{OpenLayers.Layer} The Layer with the corresponding id from the map’s layer collection, or null if not found.

+ +

Constants

+ +

CLASS_NAME

{String} OpenLayers.Map

+ +
Generated by Natural Docs
+ +
Instances of this class represent a width/height pair
This class represents a longitude and latitude pair
Instances of this class represent bounding boxes.
destroy:function()
Destroy this map
setOptions: function(options)
Change the map options
getTileSize: function()
Get the tile size for the map
getLayer: function(id)
Get a layer based on its id
Constructor for a new OpenLayers.Map instance.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Marker-js.html b/files/OpenLayers/Marker-js.html index 0461736e99..87c72ee6bc 100644 --- a/files/OpenLayers/Marker-js.html +++ b/files/OpenLayers/Marker-js.html @@ -1,50 +1,51 @@ - - -OpenLayers.Marker - OpenLayers - - - - - - - - - - -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Marker

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

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

Properties

- -

icon

{OpenLayers.Icon}

- -

lonlat

{OpenLayers.LonLat} location of object

- -

events

{<OpenLayers.Events>}

- -

map

{OpenLayers.Map}

- -

Functions

- -

OpenLayers. Marker

Paraemeters

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

draw

draw: function(px)

Calls draw on the icon, and returns that output.

Parameters

px{OpenLayers.Pixel}

Return

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

- -

moveTo

moveTo: function (px)

Move the marker to the new location.

Parameters

px{OpenLayers.Pixel}
- -

onScreen

onScreen:function()

Return

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

- -

inflate

inflate: function(inflate)

Parameters

inflate{float}
- -

setOpacity

setOpacity: function(opacity)

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

Parameters

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

display

display: function(display)

Hide or show the icon

display{Boolean}
- -

defaultIcon

OpenLayers.Marker.defaultIcon = function()

Creates a default <OpenLayers.Icon>.

Returns

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

- -
Generated by Natural Docs
- -
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
draw: function(px)
Calls draw on the icon, and returns that output.
moveTo: function (px)
Move the marker to the new location.
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
inflate: function(inflate)
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
display: function(display)
Hide or show the icon
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Marker

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

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

Properties

+ +

icon

{OpenLayers.Icon}

+ +

lonlat

{OpenLayers.LonLat} location of object

+ +

events

{<OpenLayers.Events>}

+ +

map

{OpenLayers.Map}

+ +

Functions

+ +

OpenLayers. Marker

Paraemeters

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

draw

draw: function(px)

Calls draw on the icon, and returns that output.

Parameters

px{OpenLayers.Pixel}

Return

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

+ +

moveTo

moveTo: function (px)

Move the marker to the new location.

Parameters

px{OpenLayers.Pixel}
+ +

onScreen

onScreen:function()

Return

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

+ +

inflate

inflate: function(inflate)

Parameters

inflate{float}
+ +

setOpacity

setOpacity: function(opacity)

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

Parameters

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

display

display: function(display)

Hide or show the icon

display{Boolean}
+ +

defaultIcon

OpenLayers.Marker.defaultIcon = function()

Creates a default <OpenLayers.Icon>.

Returns

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

+ +
Generated by Natural Docs
+ +
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
draw: function(px)
Calls draw on the icon, and returns that output.
moveTo: function (px)
Move the marker to the new location.
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
inflate: function(inflate)
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
display: function(display)
Hide or show the icon
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Tile-js.html b/files/OpenLayers/Tile-js.html index 46764020a9..e0065bc476 100644 --- a/files/OpenLayers/Tile-js.html +++ b/files/OpenLayers/Tile-js.html @@ -1,52 +1,53 @@ - - -OpenLayers.Tile - OpenLayers - - - - - - - - - - -
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.
- -

Properties

- -

id

{String} null

- -

layer

{OpenLayers.Layer} layer the tile is attached to

- -

url

{String} url of the request

TBD 3.0 Deprecated.  The base tile class does not need an url.  This should be handled in subclasses.  Does not belong here.

- -

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.

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

- -

draw

draw:function()

Clear out existing tile, and return whether to draw or not.  Should be called as first line of all subclasses.

Return

{Boolean} Whether the tile should be drawn or not.  If the tile is outside the maxextent, for example, will return false.

- -

moveTo

moveTo: function (bounds,
position,
redraw)

Reposition the tile.

Parameters

bounds{OpenLayers.Bounds}
position{OpenLayers.pixel}
redraw{Boolean} Call draw method on tile after moving?  Default is true
- -

clear

clear: function()

Clear the tile of any bounds/position-related data so that it can be reused in a new location.

- -

getBoundsFromBaseLayer

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.

Parameters

position{OpenLayers.Pixel}

Return

bounds{OpenLayers.Bounds}
- -
Generated by Natural Docs
- -
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
Constructor for a new OpenLayers.Tile instance.
destroy:function()
nullify references to prevent circular references and memory leaks
draw:function()
Clear out existing tile, and return whether to draw or not.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
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.
This class represents a screen coordinate, in x and y coordinates
- - + + + + + + + + + + +
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.
+ +

Properties

+ +

id

{String} null

+ +

layer

{OpenLayers.Layer} layer the tile is attached to

+ +

url

{String} url of the request

TBD 3.0 Deprecated.  The base tile class does not need an url.  This should be handled in subclasses.  Does not belong here.

+ +

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.

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

+ +

draw

draw:function()

Clear out existing tile, and return whether to draw or not.  Should be called as first line of all subclasses.

Return

{Boolean} Whether the tile should be drawn or not.  If the tile is outside the maxextent, for example, will return false.

+ +

moveTo

moveTo: function (bounds,
position,
redraw)

Reposition the tile.

Parameters

bounds{OpenLayers.Bounds}
position{OpenLayers.pixel}
redraw{Boolean} Call draw method on tile after moving?  Default is true
+ +

clear

clear: function()

Clear the tile of any bounds/position-related data so that it can be reused in a new location.

+ +

getBoundsFromBaseLayer

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.

Parameters

position{OpenLayers.Pixel}

Return

bounds{OpenLayers.Bounds}
+ +
Generated by Natural Docs
+ +
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
Constructor for a new OpenLayers.Tile instance.
destroy:function()
nullify references to prevent circular references and memory leaks
draw:function()
Clear out existing tile, and return whether to draw or not.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
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.
This class represents a screen coordinate, in x and y coordinates
+ + \ No newline at end of file diff --git a/files/OpenLayers/Tile/Image-js.html b/files/OpenLayers/Tile/Image-js.html index ad67c51daf..5cc91240f2 100644 --- a/files/OpenLayers/Tile/Image-js.html +++ b/files/OpenLayers/Tile/Image-js.html @@ -1,46 +1,47 @@ - - -OpenLayers.Tile.Image - OpenLayers - - - - - - - - - - -
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.
- -

Properties

- -

url

{String} The URL of the image being requested.  No default.  Filled in by layer.getURL() function.

- -

imgDiv

{DOMElement} The div element which wraps the image.

- -

frame

{DOMElement} The image element is appended to the frame.  Any gutter on the image will be hidden behind the frame.

- -

Functions

- -

OpenLayers. Tile. Image

Constructor for a new OpenLayers.Tile.Image 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

- -

draw

draw:function()

Check that a tile should be drawn, and draw it.

Return

{Boolean} Always returns true.

- -

clear

clear: function()

Clear the tile of any bounds/position-related data so that it can be reused in a new location.

- -

moveTo

moveTo: function (bounds,
position,
redraw)

Reposition the tile.

Parameters

bounds{OpenLayers.Bounds}
position{OpenLayers.pixel}
redraw{Boolean} Call draw method on tile after moving?  Default is true
- -

initImgDiv

initImgDiv: function()

Creates the imgDiv property on the tile.

- -

checkImgURL

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.  If the tile URL did change before the image loaded, set the imgDiv display to ‘none’, as either (a) it will be reset to visible when the new URL loads in the image, or (b) we don’t want to display this tile after all because its new bounds are outside our maxExtent.

This function should no longer be neccesary with the improvements to Grid.js in OpenLayers 2.3.  The lack of a good isEquivilantURL function caused problems in 2.2, but it’s possible that with the improved isEquivilant URL function, this might be neccesary at some point.

See discussion in the thread at http://openlayers.org- /pipermail- /dev- /2007-January- /000205.html

@private

- -
Generated by Natural Docs
- -
Constructor for a new OpenLayers.Tile.Image instance.
destroy: function()
nullify references to prevent circular references and memory leaks
draw:function()
Check that a tile should be drawn, and draw it.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
initImgDiv: function()
Creates the imgDiv property on the tile.
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.
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
- - + + + + + + + + + + +
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.
+ +

Properties

+ +

url

{String} The URL of the image being requested.  No default.  Filled in by layer.getURL() function.

+ +

imgDiv

{DOMElement} The div element which wraps the image.

+ +

frame

{DOMElement} The image element is appended to the frame.  Any gutter on the image will be hidden behind the frame.

+ +

Functions

+ +

OpenLayers. Tile. Image

Constructor for a new OpenLayers.Tile.Image 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

+ +

draw

draw:function()

Check that a tile should be drawn, and draw it.

Return

{Boolean} Always returns true.

+ +

clear

clear: function()

Clear the tile of any bounds/position-related data so that it can be reused in a new location.

+ +

moveTo

moveTo: function (bounds,
position,
redraw)

Reposition the tile.

Parameters

bounds{OpenLayers.Bounds}
position{OpenLayers.pixel}
redraw{Boolean} Call draw method on tile after moving?  Default is true
+ +

initImgDiv

initImgDiv: function()

Creates the imgDiv property on the tile.

+ +

checkImgURL

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.  If the tile URL did change before the image loaded, set the imgDiv display to ‘none’, as either (a) it will be reset to visible when the new URL loads in the image, or (b) we don’t want to display this tile after all because its new bounds are outside our maxExtent.

This function should no longer be neccesary with the improvements to Grid.js in OpenLayers 2.3.  The lack of a good isEquivilantURL function caused problems in 2.2, but it’s possible that with the improved isEquivilant URL function, this might be neccesary at some point.

See discussion in the thread at http://openlayers.org- /pipermail- /dev- /2007-January- /000205.html

@private

+ +
Generated by Natural Docs
+ +
Constructor for a new OpenLayers.Tile.Image instance.
destroy: function()
nullify references to prevent circular references and memory leaks
draw:function()
Check that a tile should be drawn, and draw it.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
initImgDiv: function()
Creates the imgDiv property on the tile.
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.
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/files/OpenLayers/Tile/WFS-js.html b/files/OpenLayers/Tile/WFS-js.html index bc27e74350..a1b8d8ce3d 100644 --- a/files/OpenLayers/Tile/WFS-js.html +++ b/files/OpenLayers/Tile/WFS-js.html @@ -1,46 +1,47 @@ - - -OpenLayers.Tile.WFS - OpenLayers - - - - - - - - - - -
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
- -

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.

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

- -

clear

clear: function()

Clear the tile of any bounds/position-related data so that it can be reused in a new location.

- -

draw

draw:function()

Check that a tile should be drawn, and load features for it.

- -

loadFeaturesForRegion

loadFeaturesForRegion:function(success,
failure)

get the full request string from the ds and the tile params and call the AJAX loadURL().

Input are function pointers for what to do on success and failure.

Parameters

success{function}
failure{function}
- -

requestSuccess

requestSuccess:function(request)

Called on return from request succcess.  Adds results via layer.addFeatures in vector mode, addResults otherwise.

Parameters

request{XMLHttpRequest}
- -

addResults

addResults: function(results)

Construct new feature via layer featureClass constructor, and add to this.features.

Parameters

results{Object}
- -

destroyAllFeatures

destroyAllFeatures: function()

Iterate through and call destroy() on each feature, removing it from the local array

@private

- -
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
- - + + + + + + + + + + +
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
+ +

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.

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

+ +

clear

clear: function()

Clear the tile of any bounds/position-related data so that it can be reused in a new location.

+ +

draw

draw:function()

Check that a tile should be drawn, and load features for it.

+ +

loadFeaturesForRegion

loadFeaturesForRegion:function(success,
failure)

get the full request string from the ds and the tile params and call the AJAX loadURL().

Input are function pointers for what to do on success and failure.

Parameters

success{function}
failure{function}
+ +

requestSuccess

requestSuccess:function(request)

Called on return from request succcess.  Adds results via layer.addFeatures in vector mode, addResults otherwise.

Parameters

request{XMLHttpRequest}
+ +

addResults

addResults: function(results)

Construct new feature via layer featureClass constructor, and add to this.features.

Parameters

results{Object}
+ +

destroyAllFeatures

destroyAllFeatures: function()

Iterate through and call destroy() on each feature, removing it from the local array

@private

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