diff --git a/authors.txt b/authors.txt deleted file mode 100644 index 072416d55a..0000000000 --- a/authors.txt +++ /dev/null @@ -1,25 +0,0 @@ -OpenLayers contributors: -Howard Butler -Bertil Chaupis -John Cole -Jeff Dege -Schuyler Erle -Christian López Espínola -John Frank -Sean Gilles -Pierre Giraud -Andreas Hocevar -Philip Lindsay -Corey Puffault -Tim Schaub -Christopher Schmidt -Cameron Shorter -Paul Spencer -James Stembridge -Erik Uzureau -Bill Woodall -Steve Woodbridge - - -OpenLayers is graciously supported by MetaCarta, Inc. -. diff --git a/customization b/customization deleted file mode 100644 index f4b5b98aa9..0000000000 --- a/customization +++ /dev/null @@ -1,49 +0,0 @@ -Customizing OpenLayers -====================== - -OpenLayers is designed to fit many needs -- fitting in alongside all kinds of -various applications which are currently in use. - -Currently, OpenLayers supports a 'theme' option when creating a map. This -theme option allows you to specify the location of a CSS theme which should -be included. - -A default theme is available as an example in the theme/ directory: the setup -is: - - * theme/ - * theme/default/ - * theme/default/style.css - * theme/default/img/ - -Currently, the OpenLayers code does not support class names, and therefore, -it is not possible to control many aspects of OpenLayers code with CSS -classes. However, with this framework in place, we expect to invest time -to make existing features and new features use the CSS theming framework -where apropriate. - - -Class Naming -============ -Elements should have class names which are descriptive of the Javascript -class from which they come. For example, the main layer switcher element -in the OpenLayers.Control.LayerSwitcher would be classed: - - olControlLayerSwitcher - -This would allow users to add to their style.css class in their theme, -changing, for example: - -:: - - .olControlLayerSwitcher input { - width:10px; - } - -Sub elements of a particular control can add to the class name: - -:: - - .olControlLayerSwitcherBaseLabel { - color: red; - } diff --git a/files/OpenLayers-js.html b/files/OpenLayers-js.html index 153d919674..494e2eee8f 100644 --- a/files/OpenLayers-js.html +++ b/files/OpenLayers-js.html @@ -1,35 +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

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.
+ + \ No newline at end of file diff --git a/files/OpenLayers/BaseTypes-js.html b/files/OpenLayers/BaseTypes-js.html index d70aea9cf0..3ddec222e6 100644 --- a/files/OpenLayers/BaseTypes-js.html +++ b/files/OpenLayers/BaseTypes-js.html @@ -1,93 +1,99 @@ - - -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 Base Types

Basic types in OpenLayers are described here.

Summary
OpenLayers Base Types
Basic types in OpenLayers are described here.
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
add
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
equals
Determine where this size is equal to another
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.
+ +

OpenLayers. Class

Contains functions to create OpenLayers style classes.

Summary
Functions
create
Create an OpenLayers style class
inherit
Inherit from one or more OpenLayers style classes
+ +

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

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.

+ +

add

add:function(x,
y)

Parameters

x{Integer}
y{Integer}

Return

{OpenLayers.Pixel} A new Pixel with this pixel’s x&y augmented by the values passed in.

+ +

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
equals
Determine where this size is equal to another
+ +

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

+ +

equals

equals:function(sz)

Determine where this size is equal to another

Parameters

sz{OpenLayers.Size}

Return

{Boolean} The passed in size has the same h and w properties as this one.  Note that if sz passed in is null, returns false.

+ +

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
add:function(x,
y)
toString:function()
Return the string representation of a size object
clone:function()
Create a clone of this size object
equals:function(sz)
Determine where this size is equal to another
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.
Create a new OpenLayers.Pixel instance
Create an instance of OpenLayers.Size
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 71e94bf280..e1d18881b2 100644 --- a/files/OpenLayers/Console-js.html +++ b/files/OpenLayers/Console-js.html @@ -1,53 +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.

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 index 8fe6e7872b..809970c1ac 100644 --- a/files/OpenLayers/Control-js.html +++ b/files/OpenLayers/Control-js.html @@ -1,29 +1,55 @@ - - -/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
- - - - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Control

Controls affect the display or behavior of the map.  They allow everything from panning and zooming to displaying a scale indicator.

Summary
OpenLayers. Control
Controls affect the display or behavior of the map.
Properties
id
{String}
map
{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map
div
{DOMElement}
type
{OpenLayers.Control.TYPES} Controls can have a ‘type’.
displayClass
{string} This property is used for CSS related to the drawing of the Control.
active
{boolean} null
handler
{<OpenLayers.Handler}> null
Functions
OpenLayers. Control
Create an OpenLayers Control.
destroy
setMap
Set the map property for the control.
draw
moveTo
activate
{Boolean}
deactivate
{Boolean}
+ +

Properties

+ +

id

{String}

+ +

map

{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map

+ +

div

{DOMElement}

+ +

type

{OpenLayers.Control.TYPES} Controls can have a ‘type’.  The type determines the type of interactions which are possible with them when they are placed into a toolbar.

+ +

displayClass

{string} This property is used for CSS related to the drawing of the Control.

+ +

active

{boolean} null

+ +

handler

{<OpenLayers.Handler}> null

+ +

Functions

+ +

OpenLayers. Control

Create an OpenLayers Control.

Parameters

options{Object}
+ +

destroy

destroy: function ()
+ +

setMap

setMap: function(map)

Set the map property for the control.  This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.

Parameters

map{OpenLayers.Map}
+ +

draw

draw: function (px)

Parameters

px{OpenLayers.Pixel}

Return

{DOMElement} A reference to the DIV DOMElement containing the control

+ +

moveTo

moveTo: function (px)

Parameters

px{OpenLayers.Pixel}
+ +

activate

activate: function ()

Return

{Boolean}

+ +

deactivate

deactivate: function ()

Return

{Boolean}

+ +
Generated by Natural Docs
+ +
destroy: function ()
setMap: function(map)
Set the map property for the control.
draw: function (px)
moveTo: function (px)
activate: function ()
{Boolean}
deactivate: function ()
{Boolean}
+ + \ No newline at end of file diff --git a/files/OpenLayers/Control/ArgParser-js.html b/files/OpenLayers/Control/ArgParser-js.html new file mode 100644 index 0000000000..2d1b622d47 --- /dev/null +++ b/files/OpenLayers/Control/ArgParser-js.html @@ -0,0 +1,33 @@ + + +OpenLayers.Control.ArgParser - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Control. ArgParser

Inherits from

Summary
OpenLayers. Control. ArgParser
Functions
OpenLayers. Control. ArgParser
setMap
Set the map property for the control.
setCenter
As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.
conigureLayers
As soon as all the layers are loaded, cycle through them and hide or show them.
+ +

Functions

+ +

OpenLayers. Control. ArgParser

Parameters

options{Object}
+ +

setMap

setMap: function(map)

Set the map property for the control.

Parameters

map{OpenLayers.Map}
+ +

setCenter

setCenter: function()

As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.

+ +

conigureLayers

As soon as all the layers are loaded, cycle through them and hide or show them.

+ +
Generated by Natural Docs
+ +
setMap: function(map)
Set the map property for the control.
setCenter: function()
As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.
Controls affect the display or behavior of the map.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Control/ZoomToMaxExtent-js.html b/files/OpenLayers/Control/ZoomToMaxExtent-js.html new file mode 100644 index 0000000000..5084d5c93c --- /dev/null +++ b/files/OpenLayers/Control/ZoomToMaxExtent-js.html @@ -0,0 +1,31 @@ + + +OpenLayers.Control.ZoomToMaxExtent - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Control. ZoomToMaxExtent

Imlements a very simple button control.  Designed to be used with a <OpenLayers.Control.Panel>.

Inherits from

Summary
OpenLayers. Control. ZoomToMaxExtent
Imlements a very simple button control.
Properties
type
TYPE_BUTTON.
Functions
trigger
Do the zoom.
+ +

Properties

+ +

type

TYPE_BUTTON.

+ +

Functions

+ +

trigger

trigger: function()

Do the zoom.

+ +
Generated by Natural Docs
+ +
trigger: function()
Do the zoom.
Controls affect the display or behavior of the map.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Events-js.html b/files/OpenLayers/Events-js.html new file mode 100644 index 0000000000..67b69afa99 --- /dev/null +++ b/files/OpenLayers/Events-js.html @@ -0,0 +1,107 @@ + + +OpenLayers.Events - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Events

Summary
OpenLayers. Events
OpenLayers. Event
Utility functions for event handling.
Properties
observers
{Object} A hashtable cache of the event observers.
Constants
KEY_BACKSPACE
{int}
KEY_TAB
{int}
KEY_RETURN
{int}
KEY_ESC
{int}
KEY_LEFT
{int}
KEY_UP
{int}
KEY_RIGHT
{int}
KEY_DOWN
{int}
KEY_DELETE
{int}
Functions
element
Cross browser event element detection.
isLeftClick
Determine whether event was caused by a left click.
stop
Stops an event from propagating.
findElement
observe
stopObservingElement
Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.
_removeElementObservers
Private.
stopObserving
unloadCache
Cycle through all the element entries in the events cache and call stopObservingElement on each.
OpenLayers. Events
Properties
listeners
{Object} Hashtable of Array(Function): events listener functions
object
{Object} the code object issuing application events
element
{DOMElement} the DOM element receiving browser events
eventTypes
{Array} list of support application events
eventHandler
{Function} bound event handler attached to elements
fallThrough
{Boolean}
Functions
OpenLayers. Events
Construct an OpenLayers.Events object.
destroy
attachToElement
register
Register an event on the events object.
registerPriority
unregister
remove
Remove all listeners for a given event type.
triggerEvent
Trigger a specified registered event
handleBrowserEvent
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
getMousePosition
Private
+ +

OpenLayers. Event

Utility functions for event handling.

Summary
Properties
observers
{Object} A hashtable cache of the event observers.
Constants
KEY_BACKSPACE
{int}
KEY_TAB
{int}
KEY_RETURN
{int}
KEY_ESC
{int}
KEY_LEFT
{int}
KEY_UP
{int}
KEY_RIGHT
{int}
KEY_DOWN
{int}
KEY_DELETE
{int}
Functions
element
Cross browser event element detection.
isLeftClick
Determine whether event was caused by a left click.
stop
Stops an event from propagating.
findElement
observe
stopObservingElement
Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.
_removeElementObservers
Private.
stopObserving
unloadCache
Cycle through all the element entries in the events cache and call stopObservingElement on each.
+ +

Properties

+ +

observers

{Object} A hashtable cache of the event observers.  Keyed by element._eventCacheID

+ +

Constants

+ +

KEY_BACKSPACE

{int}

+ +

KEY_TAB

{int}

+ +

KEY_RETURN

{int}

+ +

KEY_ESC

{int}

+ +

KEY_LEFT

{int}

+ +

KEY_UP

{int}

+ +

KEY_RIGHT

{int}

+ +

KEY_DOWN

{int}

+ +

KEY_DELETE

{int}

+ +

Functions

+ +

element

element: function(event)

Cross browser event element detection.

Parameters

event{Event}

Returns

{DOMElement} The element that caused the event

+ +

isLeftClick

isLeftClick: function(event)

Determine whether event was caused by a left click.

Parameters

event{Event}

Returns

{Boolean}

+ +

stop

stop: function(event,
allowDefault)

Stops an event from propagating.

Parameters

event{Event}
allowDefault{Boolean} If true, we stop the event chain but still allow the default browser behaviour (text selection, radio-button clicking, etc) Default false
+ +

findElement

findElement: function(event,
tagName)

Parameters

event{Event}
tagName{String}

Return

{DOMElement} The first node with the given tagName, starting from the node the event was triggered on and traversing the DOM upwards

+ +

observe

observe: function(elementParam,
name,
observer,
useCapture)

Parameters

elementParam{DOMElement || String}
name{String}
observer{function}
useCapture{Boolean}
+ +

stopObservingElement

stopObservingElement: function(elementParam)

Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.

parameters

elementParam{DOMElement || String}
+ +

_removeElementObservers

_removeElementObservers: function(elementObservers)

Private.

Parameters

elementObservers{Array(Object)} Array of (element, name, observer, usecapture) objects, taken directly from hashtable
+ +

stopObserving

stopObserving: function(elementParam,
name,
observer,
useCapture)

Parameters

elementParam{DOMElement || String}
name{String}
observer{function}
useCapture{Boolean}

@returns {Boolean} Whether or not the event observer was removed

+ +

unloadCache

unloadCache: function()

Cycle through all the element entries in the events cache and call stopObservingElement on each.

+ +

OpenLayers. Events

Summary
Properties
listeners
{Object} Hashtable of Array(Function): events listener functions
object
{Object} the code object issuing application events
element
{DOMElement} the DOM element receiving browser events
eventTypes
{Array} list of support application events
eventHandler
{Function} bound event handler attached to elements
fallThrough
{Boolean}
Functions
OpenLayers. Events
Construct an OpenLayers.Events object.
destroy
attachToElement
register
Register an event on the events object.
registerPriority
unregister
remove
Remove all listeners for a given event type.
triggerEvent
Trigger a specified registered event
handleBrowserEvent
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
getMousePosition
Private
+ +

Properties

+ +

listeners

{Object} Hashtable of Array(Function): events listener functions

+ +

object

{Object} the code object issuing application events

+ +

element

{DOMElement} the DOM element receiving browser events

+ +

eventTypes

{Array} list of support application events

+ +

eventHandler

{Function} bound event handler attached to elements

+ +

fallThrough

{Boolean}

+ +

Functions

+ +

OpenLayers. Events

Construct an OpenLayers.Events object.

Parameters

object{Object} The js object to which this Events object is being
added element{DOMElement} A dom element to respond to browser events
eventTypes{Array} Array of custom application events
fallThrough{Boolean} Allow events to fall through after these have been handled?
+ +

destroy

destroy: function ()
+ +

attachToElement

attachToElement: function (element)

Parameters

element{HTMLDOMElement} a DOM element to attach browser events to
+ +

register

register: function (type,
obj,
func)

Register an event on the events object.

When the event is triggered, the ‘func’ function will be called, in the context of ‘obj’.  Imagine we were to register an event, specifying an OpenLayers.Bounds Object as ‘obj’.  When the event is triggered, the context in the callback function will be our Bounds object.  This means that within our callback function, we can access the properties and methods of the Bounds object through the “this” variable.  So our callback could execute something like:

leftStr = "Left: " + this.left;

or

centerStr = "Center: " + this.getCenterLonLat();

Parameters

type{String} Name of the event to register
obj{Object} The object to bind the context to for the callback#.  If no object is specified, default is the Events’s ‘object’ property.
func{Function} The callback function.  If no callback is specified, this function does nothing.
+ +

registerPriority

registerPriority: function (type,
obj,
func)

Parameters

type{String} Name of the event to register
obj{Object} The object to bind the context to for the callback#.  If no object is specified, default is the Events’s ‘object’ property.
func{Function} The callback function.  If no callback is specified, this function does nothing.
+ +

unregister

unregister: function (type,
obj,
func)

Parameters

type{String}
obj{Object} If none specified, defaults to this.object
func{Function}
+ +

remove

remove: function(type)

Remove all listeners for a given event type.  If type is not registered, does nothing.

Parameters

type{String}
+ +

triggerEvent

triggerEvent: function (type,
evt)

Trigger a specified registered event

Parameters

type{String}
evt{Event}
+ +

handleBrowserEvent

handleBrowserEvent: function (evt)

Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.

Private function.

Parameters

evt{Event}
+ +

getMousePosition

getMousePosition: function (evt)

Private

Parameters

evt{Event}

Returns {OpenLayers.Pixel} The current xy coordinate of the mouse, adjusted for offsets

+ +
Generated by Natural Docs
+ +
element: function(event)
Cross browser event element detection.
isLeftClick: function(event)
Determine whether event was caused by a left click.
stop: function(event,
allowDefault)
Stops an event from propagating.
findElement: function(event,
tagName)
observe: function(elementParam,
name,
observer,
useCapture)
stopObservingElement: function(elementParam)
Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.
_removeElementObservers: function(elementObservers)
Private.
stopObserving: function(elementParam,
name,
observer,
useCapture)
unloadCache: function()
Cycle through all the element entries in the events cache and call stopObservingElement on each.
destroy: function ()
attachToElement: function (element)
register: function (type,
obj,
func)
Register an event on the events object.
registerPriority: function (type,
obj,
func)
unregister: function (type,
obj,
func)
remove: function(type)
Remove all listeners for a given event type.
triggerEvent: function (type,
evt)
Trigger a specified registered event
handleBrowserEvent: function (evt)
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
getMousePosition: function (evt)
Private
This class represents a screen coordinate, in x and y coordinates
+ + \ No newline at end of file diff --git a/files/OpenLayers/Feature-js.html b/files/OpenLayers/Feature-js.html index 27bacb139f..d5854aa31c 100644 --- a/files/OpenLayers/Feature-js.html +++ b/files/OpenLayers/Feature-js.html @@ -1,55 +1,55 @@ - - -OpenLayers.Feature - OpenLayers - - - - - - - - - - -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Feature

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

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

Properties

- -

events

{<OpenLayers.Events>}

- -

layer

{OpenLayers.Layer}

- -

id

{String}

- -

lonlat

{OpenLayers.LonLat}

- -

data

{Object}

- -

marker

{OpenLayers.Marker}

- -

popup

{OpenLayers.Popup}

- -

Functions

- -

OpenLayers. Feature

Constructor for features.

Parameters

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

Return

{OpenLayers.Feature}

- -

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

- -

onScreen

onScreen:function()

Returns

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

- -

createMarker

createMarker: function()

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

Return

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

Notethis.marker is set to return value
- -

destroyMarker

destroyMarker: function()

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

- -

createPopup

createPopup: function(closeBox)

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

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

Notethis.popup is set to return value

Parameters

closeBox{Boolean} create popup with closebox or not

Returns

{<OpenLayers.Popup.AnchoredBubble>}

- -

destroyPopup

destroyPopup: function()

Destroys the popup created via createPopup.

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

- -
Generated by Natural Docs
- -
This class represents a longitude and latitude pair
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
destroy: function()
nullify references to prevent circular references and memory leaks
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
destroyMarker: function()
Destroys marker.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
destroyPopup: function()
Destroys the popup created via createPopup.
Constructor for features.
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Feature

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

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

Properties

+ +

events

{OpenLayers.Events}

+ +

layer

{OpenLayers.Layer}

+ +

id

{String}

+ +

lonlat

{OpenLayers.LonLat}

+ +

data

{Object}

+ +

marker

{OpenLayers.Marker}

+ +

popup

{OpenLayers.Popup}

+ +

Functions

+ +

OpenLayers. Feature

Constructor for features.

Parameters

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

Return

{OpenLayers.Feature}

+ +

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

onScreen

onScreen:function()

Returns

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

+ +

createMarker

createMarker: function()

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

Return

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

Notethis.marker is set to return value
+ +

destroyMarker

destroyMarker: function()

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

+ +

createPopup

createPopup: function(closeBox)

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

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

Notethis.popup is set to return value

Parameters

closeBox{Boolean} create popup with closebox or not

Returns

{<OpenLayers.Popup.AnchoredBubble>}

+ +

destroyPopup

destroyPopup: function()

Destroys the popup created via createPopup.

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

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

OpenLayers. Feature. Vector

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

Inherits from

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

Properties

- -

fid

{String}

- -

geometry

{OpenLayers.Geometry}

- -

attributes

{Object}

- -

state

{String}

- -

style

{Object}

- -

Functions

- -

OpenLayers. Feature. Vector

Create a vector feature.

Parameters

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

- -

clone

clone: function (obj)

Returns

OpenLayers.Feature An exact clone of this OpenLayers.Feature

- -

atPoint

atPoint: function(lonlat,
toleranceLon,
toleranceLat)

Determins whether the feature intersects with the specified location.

Parameters

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

Returns

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

- -

toState

toState: function(state)

Sets the new state

Parameters

state{String}
- -

Constants

- -

OpenLayers. Feature. Vector. style

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

Default style properties

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

OpenLayers. Feature. Vector

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

Inherits from

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

Properties

+ +

fid

{String}

+ +

geometry

{OpenLayers.Geometry}

+ +

attributes

{Object}

+ +

state

{String}

+ +

style

{Object}

+ +

Functions

+ +

OpenLayers. Feature. Vector

Create a vector feature.

Parameters

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

clone

clone: function (obj)

Returns

OpenLayers.Feature An exact clone of this OpenLayers.Feature

+ +

atPoint

atPoint: function(lonlat,
toleranceLon,
toleranceLat)

Determins whether the feature intersects with the specified location.

Parameters

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

Returns

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

+ +

toState

toState: function(state)

Sets the new state

Parameters

state{String}
+ +

Constants

+ +

OpenLayers. Feature. Vector. style

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

Default style properties

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

OpenLayers. Feature.WFS

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

Inherits from

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

Functions

- -

OpenLayers. Feature.WFS

Create a WFS feature.

Parameters

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

- -

processXMLNode

processXMLNode: function(xmlNode)

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

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

Parameters

xmlNode{XMLNode}

Return

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

- -
Generated by Natural Docs
- -
destroy: function()
nullify references to prevent circular references and memory leaks
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
Features are combinations of geography and attributes.
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Feature.WFS

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

Inherits from

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

Functions

+ +

OpenLayers. Feature.WFS

Create a WFS feature.

Parameters

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

processXMLNode

processXMLNode: function(xmlNode)

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

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

Parameters

xmlNode{XMLNode}

Return

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

+ +
Generated by Natural Docs
+ +
destroy: function()
nullify references to prevent circular references and memory leaks
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
Features are combinations of geography and attributes.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Format-js.html b/files/OpenLayers/Format-js.html index 9ba7aa7f7a..a443964cde 100644 --- a/files/OpenLayers/Format-js.html +++ b/files/OpenLayers/Format-js.html @@ -1,35 +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/Format/WKT-js.html b/files/OpenLayers/Format/WKT-js.html new file mode 100644 index 0000000000..95d73cf36f --- /dev/null +++ b/files/OpenLayers/Format/WKT-js.html @@ -0,0 +1,31 @@ + + +OpenLayers.Format.WKT - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Format.WKT

Class for reading and writing Well-Known Text.  Create a new instance with the OpenLayers.Format.WKT constructor.

Inherits from

Summary
OpenLayers. Format.WKT
Class for reading and writing Well-Known Text.
Functions
OpenLayers. Format.WKT
Create a new parser for WKT
read
Deserialize a WKT string and return an OpenLayers.Feature.Vector or an array of OpenLayers.Feature.Vector.
write
Serialize a feature or array of features into a WKT string.
+ +

Functions

+ +

OpenLayers. Format.WKT

Create a new parser for WKT

Parameters

options{Object} An optional object whose properties will be set on this instance

Return

{OpenLayers.Format.WKT} A new WKT parser.

+ +

read

read: function(wkt)

Deserialize a WKT string and return an OpenLayers.Feature.Vector or an array of OpenLayers.Feature.Vector.  Supports WKT for POINT, MULTIPOINT, LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, and GEOMETRYCOLLECTION.

Parameters

wkt{String} A WKT string

Return

{<OpenLayers.Feature.Vector>|Array} A feature or array of features for GEOMETRYCOLLECTION WKT.

+ +

write

write: function(features)

Serialize a feature or array of features into a WKT string.

Parameters

features{<OpenLayers.Feature.Vector>|Array} A feature or array of features

Return

{String} The WKT string representation of the input geometries

+ +
Generated by Natural Docs
+ +
read: function(wkt)
Deserialize a WKT string and return an OpenLayers.Feature.Vector or an array of OpenLayers.Feature.Vector.
write: function(features)
Serialize a feature or array of features into a WKT string.
Create a new parser for WKT
Base class for format reading/writing a variety of formats.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry-js.html b/files/OpenLayers/Geometry-js.html index 6cecf5b43b..9cff573131 100644 --- a/files/OpenLayers/Geometry-js.html +++ b/files/OpenLayers/Geometry-js.html @@ -1,31 +1,47 @@ - - -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.  Create an instance of this class with the OpenLayers.Geometry constructor.  This is a base class, typical geometry types are described by subclasses of this class.

Summary
OpenLayers. Geometry
A Geometry is a description of a geographic object.
Properties
id
{String} A unique identifier for this geometry.
parent
{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry
bounds
{OpenLayers.Bounds} The bounds of this geometry
Functions
OpenLayers. Geometry
Creates a geometry object.
destroy
Destroy this geometry.
getLength
Calculate the length of this geometry.
getArea
Calculate the area of this geometry.
toString
Returns the Well-Known Text representation of a geometry
Constants
CLASS_NAME
{String} Name of class.
+ +

Properties

+ +

id

{String} A unique identifier for this geometry.

+ +

parent

{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry

+ +

bounds

{OpenLayers.Bounds} The bounds of this geometry

+ +

Functions

+ +

OpenLayers. Geometry

Creates a geometry object.

Returns

{OpenLayers.Geometry} geometry.

+ +

destroy

destroy: function()

Destroy this geometry.

+ +

getLength

getLength: function()

Calculate the length of this geometry.  This method is defined in subclasses.

Return

{Number} The length of the collection by summing its parts

+ +

getArea

getArea: function()

Calculate the area of this geometry.  This method is defined in subclasses.

Return

{Number} The area of the collection by summing its parts

+ +

toString

toString: function()

Returns the Well-Known Text representation of a geometry

Return

{String} Well-Known Text

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
Creates a geometry object.
Instances of this class represent bounding boxes.
destroy: function()
Destroy this geometry.
getLength: function()
Calculate the length of this geometry.
getArea: function()
Calculate the area of this geometry.
toString: function()
Returns the Well-Known Text representation of a geometry
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/Collection-js.html b/files/OpenLayers/Geometry/Collection-js.html index 20f9454f48..a0f9f76024 100644 --- a/files/OpenLayers/Geometry/Collection-js.html +++ b/files/OpenLayers/Geometry/Collection-js.html @@ -1,27 +1,59 @@ - - -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.

Create a new instance with the OpenLayers.Geometry.Collection constructor.

Inerhits from

Summary
OpenLayers. Geometry. Collection
A Collection is exactly what it sounds like: A collection of different Geometries.
Properties
components
{Array(OpenLayers.Geometry)} The component parts of this geometry
Functions
OpenLayers. Geometry. Collection
Creates a Geometry Collection -- a list of geoms.
destroy
Destroy this geometry.
clone
Clone this geometry.
getComponentsString
Get a string representing the components for this collection
calculateBounds
Recalculate the bounds by iterating through the components and calling calling extendBounds() on each item
addComponents
Add components to this geometry.
addComponent
Add a new component (geometry) to the collection.
removeComponents
Remove components from this geometry.
removeComponent
Remove a component from this geometry.
getLength
Calculate the length of this geometry
getArea
Calculate the area of this geometry.
move
Moves a collection in place
equals
Tests for equivalent geometries
Constants
CLASS_NAME
{String} Name of class.
+ +

Properties

+ +

components

{Array(OpenLayers.Geometry)} The component parts of this geometry

+ +

Functions

+ +

OpenLayers. Geometry. Collection

Creates a Geometry Collection -- a list of geoms.

Parameters

components{Array(OpenLayers.Geometry)} Optional array of geometries

Returns

{OpenLayers.Geometry.Collection} A new geometry collection

+ +

destroy

destroy: function ()

Destroy this geometry.

+ +

clone

clone: function()

Clone this geometry.

Return

{OpenLayers.Geometry.Collection} An exact clone of this collection

+ +

getComponentsString

getComponentsString: function()

Get a string representing the components for this collection

Return

{String} A string representation of the components of this geometry

+ +

calculateBounds

calculateBounds: function()

Recalculate the bounds by iterating through the components and calling calling extendBounds() on each item

+ +

addComponents

addComponents: function(components)

Add components to this geometry.

Parameters

components{Array(OpenLayers.Geometry)} An array of geometries to add
+ +

addComponent

addComponent: function(component,
index)

Add a new component (geometry) to the collection.  If this.componentTypes is set, then the component class name must be in the componentTypes array.

The bounds cache is reset.

Parameters

component{OpenLayers.Geometry} A geometry to add
index{int} Optional index into the array to insert the component

Return

{Boolean} The component geometry was successfully added

+ +

removeComponents

removeComponents: function(components)

Remove components from this geometry.

Parameters

components{Array(OpenLayers.Geometry)} The components to be removed
+ +

removeComponent

removeComponent: function(component)

Remove a component from this geometry.

Parameters

component{OpenLayers.Geometry}
+ +

getLength

getLength: function()

Calculate the length of this geometry

Return

{Number} The length of the geometry

+ +

getArea

getArea: function()

Calculate the area of this geometry.  Note how this function is overridden in OpenLayers.Geometry.Polygon.

Return

{Number} The area of the collection by summing its parts

+ +

move

move: function(x,
y)

Moves a collection in place

Parameters

x{Number} The x-displacement (in map units)
y{Number} The y-displacement (in map units)
+ +

equals

equals: function(geometry)

Tests for equivalent geometries

Parameters

geometry{OpenLayers.Geometry}

Return

{Boolean} The coordinates are equivalent

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
A Geometry is a description of a geographic object.
destroy: function ()
Destroy this geometry.
clone: function()
Clone this geometry.
getComponentsString: function()
Get a string representing the components for this collection
calculateBounds: function()
Recalculate the bounds by iterating through the components and calling calling extendBounds() on each item
addComponents: function(components)
Add components to this geometry.
addComponent: function(component,
index)
Add a new component (geometry) to the collection.
removeComponents: function(components)
Remove components from this geometry.
removeComponent: function(component)
Remove a component from this geometry.
getLength: function()
Calculate the length of this geometry
getArea: function()
Calculate the area of this geometry.
move: function(x,
y)
Moves a collection in place
equals: function(geometry)
Tests for equivalent geometries
{Array(OpenLayers.Geometry)} The component parts of this geometry
Creates a Geometry Collection -- a list of geoms.
Polygon is a collection of Geometry.LinearRings.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/LineString-js.html b/files/OpenLayers/Geometry/LineString-js.html new file mode 100644 index 0000000000..38248fe624 --- /dev/null +++ b/files/OpenLayers/Geometry/LineString-js.html @@ -0,0 +1,33 @@ + + +OpenLayers.Geometry.LineString - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. LineString

A LineString is a Curve which, once two points have been added to it, can never be less than two points long.

Inherits from

  • <OpenLayers.Geometry.Curve>
Summary
OpenLayers. Geometry. LineString
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
Functions
OpenLayers. Geometry. LineString
Create a new LineString geometry
removeComponent
Only allows removal of a point if there are three or more points in the linestring.
Constants
CLASS_NAME
{String} Name of class.
+ +

Functions

+ +

OpenLayers. Geometry. LineString

Create a new LineString geometry

Parameters

points{Array(OpenLayers.Geometry.Point)} An array of points used to generate the linestring

Return

{OpenLayers.Geometry.Point} A new Point geometry

+ +

removeComponent

removeComponent: function(point)

Only allows removal of a point if there are three or more points in the linestring.  (otherwise the result would be just a single point)

Parameters

point{OpenLayers.Geometry.Point} The point to be removed
+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
removeComponent: function(point)
Only allows removal of a point if there are three or more points in the linestring.
Point geometry class.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/MultiLineString-js.html b/files/OpenLayers/Geometry/MultiLineString-js.html index 3ccee2a612..358c9a6bdb 100644 --- a/files/OpenLayers/Geometry/MultiLineString-js.html +++ b/files/OpenLayers/Geometry/MultiLineString-js.html @@ -1,31 +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 geometry with multiple OpenLayers.Geometry.LineString components.

Inherits from

Summary
OpenLayers. Geometry. MultiLineString
A MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components.
Functions
OpenLayers. Geometry. MultiLineString
Constructor for a MultiLineString Geometry.
Constants
CLASS_NAME
{String} Name of class.
+ +

Functions

+ +

OpenLayers. Geometry. MultiLineString

Constructor for a MultiLineString Geometry.

Parameters

components{Array(OpenLayers.Geometry.LineString)}

Return

{OpenLayers.Geometry.MultiLineString} A new MultiLineString geometry

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
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 index dcbb8cba94..5db8a604f9 100644 --- a/files/OpenLayers/Geometry/MultiPoint-js.html +++ b/files/OpenLayers/Geometry/MultiPoint-js.html @@ -1,27 +1,35 @@ - - -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
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. MultiPoint

MultiPoint is a collection of Points.  Create a new instance with the OpenLayers.Geometry.MultiPoint constructor.

Inherits from

Summary
OpenLayers. Geometry. MultiPoint
MultiPoint is a collection of Points.
Functions
OpenLayers. Geometry. MultiPoint
Create a new MultiPoint Geometry
addPoint
Wrapper for OpenLayers.Geometry.Collection.addComponent
addPoint
Wrapper for OpenLayers.Geometry.Collection.removeComponent
Constants
CLASS_NAME
{String} Name of class.
+ +

Functions

+ +

OpenLayers. Geometry. MultiPoint

Create a new MultiPoint Geometry

Parameters

componentsArray({OpenLayers.Geometry.Point})

Return

{OpenLayers.Geometry.MultiPoint}

+ +

addPoint

addPoint: function(point,
index)

Wrapper for OpenLayers.Geometry.Collection.addComponent

Parameters

point{OpenLayers.Geometry.Point} Point to be added
index{Integer} Optional index
+ +

addPoint

Wrapper for OpenLayers.Geometry.Collection.removeComponent

Parameters

point{OpenLayers.Geometry.Point} Point to be removed
+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
addPoint: function(point,
index)
Wrapper for OpenLayers.Geometry.Collection.addComponent
addComponent: function(component,
index)
Add a new component (geometry) to the collection.
removeComponent: function(component)
Remove a component from this geometry.
Create a new MultiPoint Geometry
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.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/MultiPolygon-js.html b/files/OpenLayers/Geometry/MultiPolygon-js.html new file mode 100644 index 0000000000..1ded853628 --- /dev/null +++ b/files/OpenLayers/Geometry/MultiPolygon-js.html @@ -0,0 +1,31 @@ + + +OpenLayers.Geometry.MultiPolygon - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Geometry. MultiPolygon

MultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components.  Create a new instance with the OpenLayers.Geometry.MultiPolygon constructor.

Inherits from

Summary
OpenLayers. Geometry. MultiPolygon
MultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components.
Functions
OpenLayers. Geometry. MultiPolygon
Create a new MultiPolygon geometry
Constants
CLASS_NAME
{String} Name of class.
+ +

Functions

+ +

OpenLayers. Geometry. MultiPolygon

Create a new MultiPolygon geometry

Parameters

components{Array(OpenLayers.Geometry.Polygon)} An array of polygons used to generate the MultiPolygon

Return

{OpenLayers.Geometry.MultiPolygon} A new MultiPolygon geometry

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
Polygon is a collection of Geometry.LinearRings.
Create a new MultiPolygon geometry
A Collection is exactly what it sounds like: A collection of different Geometries.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Geometry/Point-js.html b/files/OpenLayers/Geometry/Point-js.html index 960c3ac020..7940c482bb 100644 --- a/files/OpenLayers/Geometry/Point-js.html +++ b/files/OpenLayers/Geometry/Point-js.html @@ -1,45 +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.
- - + + + + + + + + + + +
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 index 1102f71f00..6fe98abd06 100644 --- a/files/OpenLayers/Geometry/Polygon-js.html +++ b/files/OpenLayers/Geometry/Polygon-js.html @@ -1,29 +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.
- - + + + + + + + + + + +
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/Handler-js.html b/files/OpenLayers/Handler-js.html new file mode 100644 index 0000000000..70fa5af940 --- /dev/null +++ b/files/OpenLayers/Handler-js.html @@ -0,0 +1,55 @@ + + +OpenLayers.Handler - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Handler

Base class to construct a higher-level handler for event sequences.  Handlers are created by controls, which ultimately have the responsibility of making changes to the map.

Summary
OpenLayers. Handler
Base class to construct a higher-level handler for event sequences.
Properties
id
Private.
control
Private.
map
Private.
keyMask
{Number}
active
Private.
Functions
OpenLayers. Handler
Construct a handler.
setMap
checkModifiers
activate
Turn on the handler.
deactivate
Turn off the handler.
callback
trigger the control’s named callback with the given arguments
register
register an event on the map
unregister
unregister an event from the map
destroy
+ +

Properties

+ +

id

Private.  {String}

+ +

control

Private.  {OpenLayers.Control}.  The control that initialized this handler.

+ +

map

Private.  {OpenLayers.Map}

+ +

keyMask

{Number}

+ +

active

Private.  {Boolean}

+ +

Functions

+ +

OpenLayers. Handler

Construct a handler.

Parameters

control{OpenLayers.Control}
callbacks{Object} A hash of callback functions
options{Object}
+ +

setMap

setMap: function (map)
+ +

checkModifiers

checkModifiers: function (evt)
+ +

activate

activate: function()

Turn on the handler.  Returns false if the handler was already active.

Return

{Boolean}

+ +

deactivate

deactivate: function()

Turn off the handler.  Returns false if the handler was already inactive.

Return: {Boolean}

+ +

callback

callback: function (name,
args)

trigger the control’s named callback with the given arguments

+ +

register

register: function (name,
method)

register an event on the map

+ +

unregister

unregister: function (name,
method)

unregister an event from the map

+ +

destroy

destroy: function ()
+ +
Generated by Natural Docs
+ +
setMap: function (map)
checkModifiers: function (evt)
activate: function()
Turn on the handler.
deactivate: function()
Turn off the handler.
callback: function (name,
args)
trigger the control’s named callback with the given arguments
register: function (name,
method)
register an event on the map
unregister: function (name,
method)
unregister an event from the map
destroy: function ()
Controls affect the display or behavior of the map.
Instances of OpenLayers.Map are interactive maps embedded in a web page.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Handler/Drag-js.html b/files/OpenLayers/Handler/Drag-js.html new file mode 100644 index 0000000000..1e41829903 --- /dev/null +++ b/files/OpenLayers/Handler/Drag-js.html @@ -0,0 +1,51 @@ + + +OpenLayers.Handler.Drag - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Handler.Drag

Summary
OpenLayers. Handler.Drag
Properties
started
{Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting.
dragging
{Boolean}
start
{OpenLayers.Pixel}
oldOnselectstart
Private.
Functions
OpenLayers. Handler.Drag
Returns OpenLayers.Handler.Drag
mousedown
Handle mousedown events
mousemove
Handle mousemove events
mouseup
Handle mouseup events
mouseout
Handle mouseout events
click
The drag handler captures the click event.
activate
Activate the handler.
deactivate
Deactivate the handler.
+ +

Properties

+ +

started

{Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting.

+ +

dragging

{Boolean}

+ +

start

{OpenLayers.Pixel}

+ +

oldOnselectstart

Private.  {Function}

+ +

Functions

+ +

OpenLayers. Handler.Drag

Returns OpenLayers.Handler.Drag

Parameters

control{OpenLayers.Control}
callbacks{Object} An object containing a single function to be called when the drag operation is finished.  The callback should expect to recieve a single argument, the point geometry.
options{Object}
+ +

mousedown

mousedown: function (evt)

Handle mousedown events

Parameters

evt{Event}

Return: {Boolean} Should the event propagate

+ +

mousemove

mousemove: function (evt)

Handle mousemove events

Parameters

evt{Event}

Return: {Boolean} Should the event propagate

+ +

mouseup

mouseup: function (evt)

Handle mouseup events

Parameters

evt{Event}

Return: {Boolean} Should the event propagate

+ +

mouseout

mouseout: function (evt)

Handle mouseout events

Parameters

evt{Event}

Return: {Boolean} Should the event propagate

+ +

click

click: function (evt)

The drag handler captures the click event.  If something else registers for clicks on the same element, its listener will not be called after a drag.

Parameters

evt{Event}

Return: {Boolean} Should the event propagate

+ +

activate

activate: function()

Activate the handler.

Return: {Boolean} Was activation successful.  Returns false if already active.

+ +

deactivate

deactivate: function()

Deactivate the handler.

Return: {Boolean} Was deactivation successful.  Returns false if already active.

+ +
Generated by Natural Docs
+ +
mousedown: function (evt)
Handle mousedown events
mousemove: function (evt)
Handle mousemove events
mouseup: function (evt)
Handle mouseup events
mouseout: function (evt)
Handle mouseout events
click: function (evt)
The drag handler captures the click event.
activate: function()
Activate the handler.
deactivate: function()
Deactivate the handler.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Handler/Feature-js.html b/files/OpenLayers/Handler/Feature-js.html new file mode 100644 index 0000000000..2762bc1a3d --- /dev/null +++ b/files/OpenLayers/Handler/Feature-js.html @@ -0,0 +1,47 @@ + + +OpenLayers.Handler.Feature - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Handler. Feature

Handler to respond to mouse events related to a drawn feature.  Callbacks will be called for over, move, out, up, and down (corresponding to the equivalent mouse events).

Summary
OpenLayers. Handler. Feature
Handler to respond to mouse events related to a drawn feature.
Properties
layerIndex
{Int}
feature
{OpenLayers.Feature.Vector}
Functions
OpenLayers. Handler. Feature
mousedown
Handle mouse down.
mousemove
Handle mouse moves.
mouseup
Handle mouse up.
dblclick
Capture double-clicks.
select
Trigger the appropriate callback if a feature is under the mouse.
activate
Turn on the handler.
activate
Turn of the handler.
+ +

Properties

+ +

layerIndex

{Int}

+ +

feature

{OpenLayers.Feature.Vector}

+ +

Functions

+ +

OpenLayers. Handler. Feature

Parameters

control{OpenLayers.Control}
layers{Array} List of OpenLayers.Layer.Vector
callbacks{Array} An object with a ‘over’ property whos value is a function to be called when the mouse is over a feature.  The callback should expect to recieve a single argument, the feature.
options{Object}
+ +

mousedown

mousedown: function(evt)

Handle mouse down.  Call the “down” callback if down on a feature.

Parameters

evt{Event}
+ +

mousemove

mousemove: function(evt)

Handle mouse moves.  Call the “move” callback if moving over a feature.  Call the “over” callback if moving over a feature for the first time.  Call the “out” callback if moving off of a feature.

Parameters

evt{Event}
+ +

mouseup

mouseup: function(evt)

Handle mouse up.  Call the “up” callback if up on a feature.

Parameters

evt{Event}
+ +

dblclick

dblclick: function(evt)

Capture double-clicks.  Let the event continue propagating if the double-click doesn’t hit a feature.  Otherwise call the dblclick callback.

Parameters

evt{Event}
+ +

select

select: function(type,
evt)

Trigger the appropriate callback if a feature is under the mouse.

Parameters

type{String} Callback key

Return

{Boolean} A feature was selected

+ +

activate

activate: function()

Turn on the handler.  Returns false if the handler was already active.

Return: {Boolean}

+ +

activate

deactivate: function()

Turn of the handler.  Returns false if the handler was already active.

Returns: {Boolean}

+ +
Generated by Natural Docs
+ +
Vector features use the OpenLayers.Geometry classes as geometry description.
mousedown: function(evt)
Handle mouse down.
mousemove: function(evt)
Handle mouse moves.
mouseup: function(evt)
Handle mouse up.
dblclick: function(evt)
Capture double-clicks.
select: function(type,
evt)
Trigger the appropriate callback if a feature is under the mouse.
activate: function()
Turn on the handler.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Handler/Keyboard-js.html b/files/OpenLayers/Handler/Keyboard-js.html new file mode 100644 index 0000000000..1ba8c67b6d --- /dev/null +++ b/files/OpenLayers/Handler/Keyboard-js.html @@ -0,0 +1,43 @@ + + +OpenLayers.handler.Keyboard - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index
 + +

Constants

+ +

KEY_EVENTS

keydown, keypress, keyup

+ +

Properties

+ +

eventListener

Private.  {Function}

+ +

Functions

+ +

OpenLayers. Handler. Keyboard

+ +

destroy

destroy: function()
+ +

activate

activate: function()
+ +

deactivate

deactivate: function()
+ +

handleKeyEvent

handleKeyEvent: function (evt)
+ +
Generated by Natural Docs
+ +
destroy: function()
activate: function()
deactivate: function()
handleKeyEvent: function (evt)
Base class to construct a higher-level handler for event sequences.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Handler/MouseWheel-js.html b/files/OpenLayers/Handler/MouseWheel-js.html new file mode 100644 index 0000000000..08e9051c7c --- /dev/null +++ b/files/OpenLayers/Handler/MouseWheel-js.html @@ -0,0 +1,43 @@ + + +OpenLayers.Handler.MouseWheel - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Handler. MouseWheel

Handler for wheel up/down events.

Inherits from

Summary
OpenLayers. Handler. MouseWheel
Handler for wheel up/down events.
Properties
wheelListener
{function}
mousePosition
Private.
Functions
OpenLayers. Handler. MouseWheel
destroy
onWheelEvent
Catch the wheel event and handle it xbrowserly
mousemove
Update the stored mousePosition on every move.
activate
deactivate
+ +

Properties

+ +

wheelListener

{function}

+ +

mousePosition

Private.  {OpenLayers.Pixel} mousePosition is necessary because evt.clientX/Y is buggy in Moz on wheel events, so we cache and use the value from the last mousemove.

+ +

Functions

+ +

OpenLayers. Handler. MouseWheel

Parameters

control{OpenLayers.Control}
callbacks{Object} An object containing a single function to be called when the drag operation is finished.  The callback should expect to recieve a single argument, the point geometry.
options{Object}
+ +

destroy

destroy: function()
+ +

onWheelEvent

onWheelEvent: function(e)

Catch the wheel event and handle it xbrowserly

Parameters

e{Event}
+ +

mousemove

mousemove: function (evt)

Update the stored mousePosition on every move.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

activate

activate: function (evt)
+ +

deactivate

deactivate: function (evt)
+ +
Generated by Natural Docs
+ +
destroy: function()
onWheelEvent: function(e)
Catch the wheel event and handle it xbrowserly
mousemove: function (evt)
Update the stored mousePosition on every move.
activate: function (evt)
deactivate: function (evt)
Base class to construct a higher-level handler for event sequences.
This class represents a screen coordinate, in x and y coordinates
+ + \ No newline at end of file diff --git a/files/OpenLayers/Handler/Path-js.html b/files/OpenLayers/Handler/Path-js.html new file mode 100644 index 0000000000..3ea4e07e89 --- /dev/null +++ b/files/OpenLayers/Handler/Path-js.html @@ -0,0 +1,61 @@ + + +OpenLayers.Handler.Path - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Handler.Path

Handler to draw a path on the map.  Path is displayed on mouse down, moves on mouse move, and is finished on mouse up.

Inherits from

Summary
OpenLayers. Handler.Path
Handler to draw a path on the map.
Properties
line
Private.
freehand
{Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up.
freehandToggle
{String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand.
Functions
OpenLayers. Handler.Path
Create a new path hander
createFeature
Private.
destroyFeature
Private.
addPoint
Private.
freehandMode
Private.
modifyFeature
Private.
drawFeature
Private.
geometryClone
Private.
mousedown
Private.
mousemove
Private.
mouseup
Private.
dblclick
Private.
Constants
CLASS_NAME
{String} Name of class.
+ +

Properties

+ +

line

Private.  {OpenLayers.Feature.Vector}

+ +

freehand

{Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up.  Outside of freehand mode, a point is added to the path on every mouse click and double-click finishes the path.

+ +

freehandToggle

{String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand.  To disallow toggling between freehand and non-freehand mode, set freehandToggle to null.  Acceptable toggle values are ‘shiftKey’, ‘ctrlKey’, and ‘altKey’.

+ +

Functions

+ +

OpenLayers. Handler.Path

Create a new path hander

Parameters

control{OpenLayers.Control}
callbacks{Array} An object with a ‘done’ property whos value is a function to be called when the path drawing is finished.  The callback should expect to recieve a single argument, the line string geometry.  If the callbacks object contains a ‘point’ property, this function will be sent each point as they are added.  If the callbacks object contains a ‘cancel’ property, this function will be called when the handler is deactivated while drawing.  The cancel should expect to receive a geometry.
options{Object} An optional object with properties to be set on the handler
+ +

createFeature

createFeature: function()

Private.  Add temporary geometries

+ +

destroyFeature

destroyFeature: function()

Private.  Destroy temporary geometries

+ +

addPoint

addPoint: function()

Private.  Add point to geometry.  Send the point index to override the behavior of LinearRing that disregards adding duplicate points.

+ +

freehandMode

freehandMode: function(evt)

Private.  Determine whether to behave in freehand mode or not.

Return: {Boolean}

+ +

modifyFeature

modifyFeature: function()

Private.  Modify the existing geometry given the new point

+ +

drawFeature

drawFeature: function()

Private.  Render geometries on the temporary layer.

+ +

geometryClone

geometryClone: function()

Private.  Return a clone of the relevant geometry.

Return: {OpenLayers.Geometry.LineString}

+ +

mousedown

mousedown: function(evt)

Private.  Handle mouse down.  Add a new point to the geometry and render it.  Return determines whether to propagate the event on the map.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

mousemove

mousemove: function (evt)

Private.  Handle mouse move.  Adjust the geometry and redraw.  Return determines whether to propagate the event on the map.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

mouseup

mouseup: function (evt)

Private.  Handle mouse up.  Send the latest point in the geometry to the control.  Return determines whether to propagate the event on the map.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

dblclick

dblclick: function(evt)

Private.  Handle double-clicks.  Finish the geometry and send it back to the control.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
createFeature: function()
Private.
destroyFeature: function()
Private.
addPoint: function()
Private.
freehandMode: function(evt)
Private.
modifyFeature: function()
Private.
drawFeature: function()
Private.
geometryClone: function()
Private.
mousedown: function(evt)
Private.
mousemove: function (evt)
Private.
mouseup: function (evt)
Private.
dblclick: function(evt)
Private.
Handler to draw a point on the map.
Vector features use the OpenLayers.Geometry classes as geometry description.
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Handler/Point-js.html b/files/OpenLayers/Handler/Point-js.html new file mode 100644 index 0000000000..f4e7ebbdb4 --- /dev/null +++ b/files/OpenLayers/Handler/Point-js.html @@ -0,0 +1,69 @@ + + +OpenLayers.Handler.Point - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Handler. Point

Handler to draw a point on the map.  Point is displayed on mouse down, moves on mouse move, and is finished on mouse up.  The handler triggers callbacks for ‘done’ and ‘cancel’.  Create a new instance with the OpenLayers.Handler.Point constructor.

Inherits from

Summary
OpenLayers. Handler. Point
Handler to draw a point on the map.
Properties
point
{OpenLayers.Feature.Vector} The currently drawn point
layer
{OpenLayers.Layer.Vector} The temporary drawing layer
drawing
{Boolean} A point is being drawn
mouseDown
{Boolean} The mouse is down
lastDown
{OpenLayers.Pixel} Location of the last mouse down
lastUp
{OpenLayers.Pixel}
Functions
OpenLayers. Handler. Point
Create a new point handler.
activate
turn on the handler
createFeature
Add temporary features
deactivate
turn off the handler
destroyFeature
Destroy the temporary geometries
finalize
Finish the geometry and call the “done” callback.
cancel
Finish the geometry and call the “cancel” callback.
dblclick
Handle double clicks.
drawFeature
Render features on the temporary layer.
geometryClone
Return a clone of the relevant geometry.
mousedown
Handle mouse down.
mousemove
Handle mouse move.
mouseup
Handle mouse up.
Constants
CLASS_NAME
{String} Name of class.
+ +

Properties

+ +

point

{OpenLayers.Feature.Vector} The currently drawn point

+ +

layer

{OpenLayers.Layer.Vector} The temporary drawing layer

+ +

drawing

{Boolean} A point is being drawn

+ +

mouseDown

{Boolean} The mouse is down

+ +

lastDown

{OpenLayers.Pixel} Location of the last mouse down

+ +

lastUp

{OpenLayers.Pixel}

+ +

Functions

+ +

OpenLayers. Handler. Point

Create a new point handler.

Parameters

control{OpenLayers.Control} The control that owns this handler
callbacks{Array} An object with a ‘done’ property whos value is a function to be called when the point drawing is finished.  The callback should expect to recieve a single argument, the point geometry.  If the callbacks object contains a ‘cancel’ property, this function will be called when the handler is deactivated while drawing.  The cancel should expect to receive a geometry.
options{Object} An optional object with properties to be set on the handler
+ +

activate

activate: function()

turn on the handler

+ +

createFeature

createFeature: function()

Add temporary features

+ +

deactivate

deactivate: function()

turn off the handler

+ +

destroyFeature

destroyFeature: function()

Destroy the temporary geometries

+ +

finalize

finalize: function()

Finish the geometry and call the “done” callback.

+ +

cancel

cancel: function()

Finish the geometry and call the “cancel” callback.

+ +

dblclick

dblclick: function(evt)

Handle double clicks.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

drawFeature

drawFeature: function()

Render features on the temporary layer.

+ +

geometryClone

geometryClone: function()

Return a clone of the relevant geometry.

Return: {OpenLayers.Geometry.Point}

+ +

mousedown

mousedown: function(evt)

Handle mouse down.  Adjust the geometry and redraw.  Return determines whether to propagate the event on the map.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

mousemove

mousemove: function (evt)

Handle mouse move.  Adjust the geometry and redraw.  Return determines whether to propagate the event on the map.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

mouseup

mouseup: function (evt)

Handle mouse up.  Send the latest point in the geometry to the control.  Return determines whether to propagate the event on the map.

Parameters

evt{Event} The browser event

Return

{Boolean} Allow event propagation

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
Vector features use the OpenLayers.Geometry classes as geometry description.
Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
This class represents a screen coordinate, in x and y coordinates
activate: function()
turn on the handler
createFeature: function()
Add temporary features
deactivate: function()
turn off the handler
destroyFeature: function()
Destroy the temporary geometries
finalize: function()
Finish the geometry and call the “done” callback.
cancel: function()
Finish the geometry and call the “cancel” callback.
dblclick: function(evt)
Handle double clicks.
drawFeature: function()
Render features on the temporary layer.
geometryClone: function()
Return a clone of the relevant geometry.
mousedown: function(evt)
Handle mouse down.
mousemove: function (evt)
Handle mouse move.
mouseup: function (evt)
Handle mouse up.
Create a new point handler.
Base class to construct a higher-level handler for event sequences.
Controls affect the display or behavior of the map.
Point geometry class.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Icon-js.html b/files/OpenLayers/Icon-js.html index 6a5966c8b1..7759208c1c 100644 --- a/files/OpenLayers/Icon-js.html +++ b/files/OpenLayers/Icon-js.html @@ -1,55 +1,55 @@ - - -OpenLayers.Icon - OpenLayers - - - - - - - - - - -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers.Icon

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

Properties

- -

url

{String} image url

- -

size

{OpenLayers.Size}

- -

offset

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

- -

calculateOffset

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

- -

imageDiv

{DOMElement}

- -

px

{OpenLayers.Pixel}

- -

Functions

- -

OpenLayers.Icon

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

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

- -

clone

clone: function()

Returns

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

- -

setSize

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

draw

draw: function(px)

Move the div to the given pixel.

Parameters

px{OpenLayers.Pixel}

Returns

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

- -

setOpacity

setOpacity: function(opacity)

Change the icon’s opacity

Parameters

opacity{float}
- -

moveTo

moveTo: function (px)

move icon to passed in px.

Parameters

px{OpenLayers.Pixel}
- -

display

display: function(display)

Hide or show the icon

Parameters

display{Boolean}
- -
Generated by Natural Docs
- -
Instances of this class represent a width/height pair
This class represents a screen coordinate, in x and y coordinates
destroy: function()
nullify references to prevent circular references and memory leaks
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
Creates an icon, which is an image tag in a div.
setSize: function(size)
draw: function(px)
Move the div to the given pixel.
setOpacity: function(opacity)
Change the icon’s opacity
moveTo: function (px)
move icon to passed in px.
display: function(display)
Hide or show the icon
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers.Icon

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

Properties

+ +

url

{String} image url

+ +

size

{OpenLayers.Size}

+ +

offset

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

+ +

calculateOffset

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

+ +

imageDiv

{DOMElement}

+ +

px

{OpenLayers.Pixel}

+ +

Functions

+ +

OpenLayers.Icon

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

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

clone

clone: function()

Returns

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

+ +

setSize

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

draw

draw: function(px)

Move the div to the given pixel.

Parameters

px{OpenLayers.Pixel}

Returns

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

+ +

setOpacity

setOpacity: function(opacity)

Change the icon’s opacity

Parameters

opacity{float}
+ +

moveTo

moveTo: function (px)

move icon to passed in px.

Parameters

px{OpenLayers.Pixel}
+ +

display

display: function(display)

Hide or show the icon

Parameters

display{Boolean}
+ +
Generated by Natural Docs
+ +
Instances of this class represent a width/height pair
This class represents a screen coordinate, in x and y coordinates
destroy: function()
nullify references to prevent circular references and memory leaks
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
Creates an icon, which is an image tag in a div.
setSize: function(size)
draw: function(px)
Move the div to the given pixel.
setOpacity: function(opacity)
Change the icon’s opacity
moveTo: function (px)
move icon to passed in px.
display: function(display)
Hide or show the icon
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer-js.html b/files/OpenLayers/Layer-js.html index 721fe13d88..89ccbd4c7c 100644 --- a/files/OpenLayers/Layer-js.html +++ b/files/OpenLayers/Layer-js.html @@ -1,61 +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/GeoRSS-js.html b/files/OpenLayers/Layer/GeoRSS-js.html new file mode 100644 index 0000000000..95478138af --- /dev/null +++ b/files/OpenLayers/Layer/GeoRSS-js.html @@ -0,0 +1,45 @@ + + +OpenLayers.Layer.GeoRSS - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Layer. GeoRSS

Add GeoRSS Point features to your map.

Inherits from

Summary
OpenLayers. Layer. GeoRSS
Add GeoRSS Point features to your map.
Properties
location
{String} store url of text file
features
Array({OpenLayers.Feature})
selectedFeature
{OpenLayers.Feature}
icon
{OpenLayers.Icon}
Functions
OpenLayers. Layer. GeoRSS
Create a GeoRSS Layer.
destroy
parseData
Parse the data returned from the Events call.
markerClick
clearFeatures
Destroy all features in this layer.
+ +

Properties

+ +

location

{String} store url of text file

+ +

features

Array({OpenLayers.Feature})

+ +

selectedFeature

{OpenLayers.Feature}

+ +

icon

{OpenLayers.Icon}

+ +

Functions

+ +

OpenLayers. Layer. GeoRSS

Create a GeoRSS Layer.

Parameters

name{String}
location{String}
options{Object}
+ +

destroy

destroy: function()
+ +

parseData

parseData: function(ajaxRequest)

Parse the data returned from the Events call.

Parameters

ajaxRequest{XMLHttpRequest}
+ +

markerClick

markerClick: function(evt)

Parameters

evt{Event}
+ +

clearFeatures

clearFeatures: function()

Destroy all features in this layer.

+ +
Generated by Natural Docs
+ +
Features are combinations of geography and attributes.
destroy: function()
parseData: function(ajaxRequest)
Parse the data returned from the Events call.
markerClick: function(evt)
clearFeatures: function()
Destroy all features in this layer.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer/Image-js.html b/files/OpenLayers/Layer/Image-js.html index 48ecd4d05a..072c47a80e 100644 --- a/files/OpenLayers/Layer/Image-js.html +++ b/files/OpenLayers/Layer/Image-js.html @@ -1,49 +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/Markers-js.html b/files/OpenLayers/Layer/Markers-js.html new file mode 100644 index 0000000000..c8aee2c76f --- /dev/null +++ b/files/OpenLayers/Layer/Markers-js.html @@ -0,0 +1,49 @@ + + +OpenLayers.Layer.Markers - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Layer. Markers

Inherits from

Summary
OpenLayers. Layer. Markers
Properties
isBaseLayer
{Boolean} Markers layer is never a base layer.
markers
Array({OpenLayers.Marker}) internal marker list
drawn
{Boolean} internal state of drawing.
Functions
OpenLayers. Layer. Markers
Create a Markers layer.
destroy
moveTo
addMarker
removeMarker
clearMarkers
redraw
clear all the marker div’s from the layer and then redraw all of them.
drawMarker
Private.
+ +

Properties

+ +

isBaseLayer

{Boolean} Markers layer is never a base layer.

+ +

markers

Array({OpenLayers.Marker}) internal marker list

+ +

drawn

{Boolean} internal state of drawing.  This is a workaround for the fact that the map does not call moveTo with a zoomChanged when the map is first starting up.  This lets us catch the case where we have never drawn the layer, and draw it even if the zoom hasn’t changed.

+ +

Functions

+ +

OpenLayers. Layer. Markers

Create a Markers layer.

Parameters

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

destroy

destroy: function()
+ +

moveTo

moveTo:function(bounds,
zoomChanged,
dragging)

Parameters

bounds{OpenLayers.Bounds}
zoomChanged{Boolean}
dragging{Boolean}
+ +

addMarker

addMarker: function(marker)

Parameters

marker{OpenLayers.Marker}
+ +

removeMarker

removeMarker: function(marker)

Parameters

marker{OpenLayers.Marker}
+ +

clearMarkers

clearMarkers: function()
+ +

redraw

redraw: function()

clear all the marker div’s from the layer and then redraw all of them.  Use the map to recalculate new placement of markers.

+ +

drawMarker

drawMarker: function(marker)

Private.  Calculate the pixel location for the marker, create it, and add it to the layer’s div

Parameters

marker{OpenLayers.Marker}
+ +
Generated by Natural Docs
+ +
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
destroy: function()
moveTo:function(bounds,
zoomChanged,
dragging)
addMarker: function(marker)
removeMarker: function(marker)
clearMarkers: function()
redraw: function()
clear all the marker div’s from the layer and then redraw all of them.
drawMarker: function(marker)
Private.
Instances of this class represent bounding boxes.
+ + \ No newline at end of file diff --git a/files/OpenLayers/Layer/Vector-js.html b/files/OpenLayers/Layer/Vector-js.html index 84ad0849c0..f85b491506 100644 --- a/files/OpenLayers/Layer/Vector-js.html +++ b/files/OpenLayers/Layer/Vector-js.html @@ -1,37 +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 ae67077042..3289eb02b9 100644 --- a/files/OpenLayers/Layer/WMS-js.html +++ b/files/OpenLayers/Layer/WMS-js.html @@ -1,45 +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 272ea44e44..f8fd5a408c 100644 --- a/files/OpenLayers/Map-js.html +++ b/files/OpenLayers/Map-js.html @@ -1,103 +1,119 @@ - - -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
setLayerZIndex
Private.
addLayer
addLayers
removeLayer
Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map’s internal list of layers, setting the layer’s map property to null.
getNumLayers
Return: {Int} The number of layers attached to the map.
getLayerIndex
@param {OpenLayers.Layer} layer
setLayerIndex
Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.
raiseLayer
Change the index of the given layer by delta.
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.

+ +

setLayerZIndex

setLayerZIndex: function (layer,
zIdx)

Private.

Parameters

layer{OpenLayers.Layer}
zIdx{int}
+ +

addLayer

addLayer: function (layer)

Parameters

layer{OpenLayers.Layer}
+ +

addLayers

addLayers: function (layers)

Parameters

layersArray({OpenLayers.Layer})
+ +

removeLayer

removeLayer: function(layer,
setNewBaseLayer)

Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map’s internal list of layers, setting the layer’s map property to null.

a “removelayer” event is triggered.

very worthy of mention is that simply removing a layer from a map will not cause the removal of any popups which may have been created by the layer. this is due to the fact that it was decided at some point that popups would not belong to layers. thus there is no way for us to know here to which layer the popup belongs.

A simple solution to this is simply to call destroy() on the layer. the default OpenLayers.Layer class’s destroy() function automatically takes care to remove itself from whatever map it has been attached to.

The correct solution is for the layer itself to register an event-handler on “removelayer” and when it is called, if it recognizes itself as the layer being removed, then it cycles through its own personal list of popups, removing them from the map.

Parameters

layer{OpenLayers.Layer}
setNewBaseLayer{Boolean} Default is true
+ +

getNumLayers

getNumLayers: function ()

Return: {Int} The number of layers attached to the map.

+ +

getLayerIndex

getLayerIndex: function (layer)

Parameters

@param {OpenLayers.Layer} layer

Return

{Int} The current (zero-based) index of the given layer in the map’s layer stack.  Returns -1 if the layer isn’t on the map.

+ +

setLayerIndex

setLayerIndex: function (layer,
idx)

Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.  Use map.getLayerIndex() to find out the current index of a layer.  Note that this cannot (or at least should not) be effectively used to raise base layers above overlays.

Parameters

layer{OpenLayers.Layer}
idx{int}
+ +

raiseLayer

raiseLayer: function (layer,
delta)

Change the index of the given layer by delta.  If delta is positive, the layer is moved up the map’s layer stack; if delta is negative, the layer is moved down.  Again, note that this cannot (or at least should not) be effectively used to raise base layers above overlays.

Paremeters

layer{OpenLayers.Layer}
idx{int}
+ +

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
Controls affect the display or behavior of the map.
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
setLayerZIndex: function (layer,
zIdx)
Private.
addLayer: function (layer)
addLayers: function (layers)
removeLayer: function(layer,
setNewBaseLayer)
Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map’s internal list of layers, setting the layer’s map property to null.
getNumLayers: function ()
Return: {Int} The number of layers attached to the map.
getLayerIndex: function (layer)
@param {OpenLayers.Layer} layer
setLayerIndex: function (layer,
idx)
Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.
raiseLayer: function (layer,
delta)
Change the index of the given layer by delta.
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 37e7be1cc3..dbf38b7480 100644 --- a/files/OpenLayers/Marker-js.html +++ b/files/OpenLayers/Marker-js.html @@ -1,51 +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/Marker/Box-js.html b/files/OpenLayers/Marker/Box-js.html new file mode 100644 index 0000000000..94204a985a --- /dev/null +++ b/files/OpenLayers/Marker/Box-js.html @@ -0,0 +1,43 @@ + + +OpenLayers.Marker.Box - OpenLayers + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Marker.Box

Inherits from

Summary
OpenLayers. Marker.Box
Properties
bounds
{OpenLayers.Bounds}
div
{DOMElement}
Functions
OpenLayers. Marker.Box
destroy
setBorder
Allow the user to change the box’s color and border width
draw
onScreen
{Boolean} Whether or not the marker is currently visible on screen.
display
Hide or show the icon
+ +

Properties

+ +

bounds

{OpenLayers.Bounds}

+ +

div

{DOMElement}

+ +

Functions

+ +

OpenLayers. Marker.Box

Parameters

bounds{OpenLayers.Bounds}
borderColor{String}
borderWidth{int}
+ +

destroy

destroy: function()
+ +

setBorder

setBorder: function (color,
width)

Allow the user to change the box’s color and border width

Parameters

color{String} Default is “red”
width{int} Default is 2
+ +

draw

draw: function(px,
sz)

Parameters

px{OpenLayers.Pixel}
sz{OpenLayers.Size}

Return

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

+ +

onScreen

onScreen:function()

Rreturn

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

+ +

display

display: function(display)

Hide or show the icon

Parameters

display{Boolean}
+ +
Generated by Natural Docs
+ +
Instances of this class represent bounding boxes.
destroy: function()
setBorder: function (color,
width)
Allow the user to change the box’s color and border width
draw: function(px,
sz)
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
display: function(display)
Hide or show the icon
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
+ + \ No newline at end of file diff --git a/files/OpenLayers/Popup-js.html b/files/OpenLayers/Popup-js.html index 4cd2664cb8..9a74509aeb 100644 --- a/files/OpenLayers/Popup-js.html +++ b/files/OpenLayers/Popup-js.html @@ -1,93 +1,93 @@ - - -OpenLayers.Popup - OpenLayers - - - - - - - - - - -
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Popup

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

Properties

- -

events

{<OpenLayers.Events>}

- -

lonlat

{OpenLayers.LonLat}

- -

div

{DOMElement}

- -

size

{OpenLayers.Size}

- -

contentHTML

{String}

- -

backgroundColor

{String}

- -

opacity

{float}

- -

border

{String}

- -

contentDiv

{DOMElement}

- -

groupDiv

{DOMElement}

- -

padding

{int}

- -

map

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

- -

Functions

- -

OpenLayers. Popup

Create a popup.

Parameters

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

- -

draw

draw: function(px)

Parameters

px{OpenLayers.Pixel}

Return

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

- -

updatePosition

updatePosition: function()

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

- -

moveTo

moveTo: function(px)

Parameters

px{OpenLayers.Pixel}
- -

visible

visible: function()

Returns

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

- -

toggle

toggle: function()
- -

show

show: function()
- -

hide

hide: function()
- -

setSize

setSize:function(size)

Parameters

size{OpenLayers.Size}
- -

setBackgroundColor

setBackgroundColor:function(color)

Parameters

color{String}
- -

setOpacity

setOpacity:function(opacity)

Parameters

opacity{float}
- -

setBorder

setBorder:function(border)

Parameters

border{int}
- -

setContentHTML

setContentHTML:function(contentHTML)

Parameters

contentHTML{String}
- -

registerEvents

registerEvents:function()

Registers events on the popup.

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

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

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

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

- -

onmousedown

onmousedown: function (evt)

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

Parameters

evt{Event}
- -

onmousemove

onmousemove: function (evt)

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

Parameters

evt{Event}
- -

onmouseup

onmouseup: function (evt)

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

Parameters

evt{Event}
- -

onclick

onclick: function (evt)

Ignore clicks, but allowing default browser handling

Parameters

evt{Event}
- -

onmouseout

onmouseout: function (evt)

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

Parameters

evt{Event}
- -

ondblclick

ondblclick: function (evt)

Ignore double-clicks, but allowing default browser handling

Parameters

evt{Event}
- -
Generated by Natural Docs
- -
This class represents a longitude and latitude pair
Instances of this class represent a width/height pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
destroy: function()
nullify references to prevent circular references and memory leaks
draw: function(px)
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
moveTo: function(px)
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
toggle: function()
show: function()
hide: function()
setSize:function(size)
setBackgroundColor:function(color)
setOpacity:function(opacity)
setBorder:function(border)
setContentHTML:function(contentHTML)
registerEvents:function()
Registers events on the popup.
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onclick: function (evt)
Ignore clicks, but allowing default browser handling
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
This class represents a screen coordinate, in x and y coordinates
- - + + + + + + + + + + +
OpenLayers
JavaScript Mapping Library
OpenLayers
OpenLayers
Index

OpenLayers. Popup

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

Properties

+ +

events

{OpenLayers.Events}

+ +

lonlat

{OpenLayers.LonLat}

+ +

div

{DOMElement}

+ +

size

{OpenLayers.Size}

+ +

contentHTML

{String}

+ +

backgroundColor

{String}

+ +

opacity

{float}

+ +

border

{String}

+ +

contentDiv

{DOMElement}

+ +

groupDiv

{DOMElement}

+ +

padding

{int}

+ +

map

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

+ +

Functions

+ +

OpenLayers. Popup

Create a popup.

Parameters

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

destroy

destroy: function()

nullify references to prevent circular references and memory leaks

+ +

draw

draw: function(px)

Parameters

px{OpenLayers.Pixel}

Return

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

+ +

updatePosition

updatePosition: function()

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

+ +

moveTo

moveTo: function(px)

Parameters

px{OpenLayers.Pixel}
+ +

visible

visible: function()

Returns

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

+ +

toggle

toggle: function()
+ +

show

show: function()
+ +

hide

hide: function()
+ +

setSize

setSize:function(size)

Parameters

size{OpenLayers.Size}
+ +

setBackgroundColor

setBackgroundColor:function(color)

Parameters

color{String}
+ +

setOpacity

setOpacity:function(opacity)

Parameters

opacity{float}
+ +

setBorder

setBorder:function(border)

Parameters

border{int}
+ +

setContentHTML

setContentHTML:function(contentHTML)

Parameters

contentHTML{String}
+ +

registerEvents

registerEvents:function()

Registers events on the popup.

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

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

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

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

+ +

onmousedown

onmousedown: function (evt)

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

Parameters

evt{Event}
+ +

onmousemove

onmousemove: function (evt)

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

Parameters

evt{Event}
+ +

onmouseup

onmouseup: function (evt)

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

Parameters

evt{Event}
+ +

onclick

onclick: function (evt)

Ignore clicks, but allowing default browser handling

Parameters

evt{Event}
+ +

onmouseout

onmouseout: function (evt)

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

Parameters

evt{Event}
+ +

ondblclick

ondblclick: function (evt)

Ignore double-clicks, but allowing default browser handling

Parameters

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

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.
Constants
CLASS_NAME
{String} Name of class.
+ +

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

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
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 e14ac9ecfe..a23bc44262 100644 --- a/files/OpenLayers/Tile/WFS-js.html +++ b/files/OpenLayers/Tile/WFS-js.html @@ -1,47 +1,51 @@ - - -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
- -
Features are combinations of geography and attributes.
Constructor for a new OpenLayers.Tile.WFS instance.
destroy: function()
nullify references to prevent circular references and memory leaks
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
draw:function()
Check that a tile should be drawn, and load features for it.
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
requestSuccess:function(request)
Called on return from request succcess.
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
- - + + + + + + + + + + +
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

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
Constants
CLASS_NAME
{String} Name of class.
+ +

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

+ +

Constants

+ +

CLASS_NAME

{String} Name of class.

+ +
Generated by Natural Docs
+ +
Features are combinations of geography and attributes.
Constructor for a new OpenLayers.Tile.WFS instance.
destroy: function()
nullify references to prevent circular references and memory leaks
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
draw:function()
Check that a tile should be drawn, and load features for it.
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
requestSuccess:function(request)
Called on return from request succcess.
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent bounding boxes.
Instances of this class represent a width/height pair
+ + \ No newline at end of file diff --git a/index/Classes.html b/index/Classes.html index 94c1cd7fc2..6d54cbcd57 100644 --- a/index/Classes.html +++ b/index/Classes.html @@ -1,17 +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. Feature
 OpenLayers. Feature. Vector
 OpenLayers. Feature.WFS
 OpenLayers. Format
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 OpenLayers.Icon
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Marker.Box
 OpenLayers. Pixel
 OpenLayers. Popup
 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.
Features are combinations of geography and attributes.
Vector features use the OpenLayers.Geometry classes as geometry description.
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
Base class for format reading/writing a variety of formats.
A Geometry is a description of a geographic object.
A Collection is exactly what it sounds like: A collection of different Geometries.
A MultiLineString is a collection of LineStrings.
MultiPoint is a collection of Points.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
Instances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer.
Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services.
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent a width/height pair
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
- -
Generated by Natural Docs
+ + + + + + +
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. Control
 OpenLayers. Control. ArgParser
 OpenLayers. Control. ZoomToMaxExtent
 OpenLayers. Event
 OpenLayers. Feature
 OpenLayers. Feature. Vector
 OpenLayers. Feature.WFS
 OpenLayers. Format
 OpenLayers. Format.WKT
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. LineString
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. MultiPolygon
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 OpenLayers. Handler
 OpenLayers. Handler.Drag
 OpenLayers. Handler. Feature
 OpenLayers. handler. Keyboard
 OpenLayers. Handler. MouseWheel
 OpenLayers. Handler.Path
 OpenLayers. Handler. Point
 OpenLayers.Icon
 OpenLayers. Layer
 OpenLayers. Layer. GeoRSS
 OpenLayers. Layer. Image
 OpenLayers. Layer. Markers
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Marker.Box
 OpenLayers. Pixel
 OpenLayers. Popup
 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.
Controls affect the display or behavior of the map.
Imlements a very simple button control.
Utility functions for event handling.
Features are combinations of geography and attributes.
Vector features use the OpenLayers.Geometry classes as geometry description.
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
Base class for format reading/writing a variety of formats.
Class for reading and writing Well-Known Text.
A Geometry is a description of a geographic object.
A Collection is exactly what it sounds like: A collection of different Geometries.
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
A MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components.
MultiPoint is a collection of Points.
MultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
Base class to construct a higher-level handler for event sequences.
Handler to respond to mouse events related to a drawn feature.
Handler for wheel up/down events.
Handler to draw a path on the map.
Handler to draw a point on the map.
Add GeoRSS Point features to your map.
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 78c136546d..64ebfcb2ca 100644 --- a/index/Constants.html +++ b/index/Constants.html @@ -1,41 +1,45 @@ - - -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
S
 style, OpenLayers. Feature. Vector. OpenLayers. Feature. Vector
T
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
V
 VERSION_NUMBER, OpenLayers
Z
 Z_INDEX_BASE, OpenLayers.Map
- -
{String} OpenLayers.Format
Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
- - - -
{Object} Hashtable of default parameter key/value pairs
- - - -
{Array} supported application event types
- - - -
OpenLayers features can have a number of style attributes.
- - - -
{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. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. LineStringOpenLayers. Geometry. MultiLineStringOpenLayers. Geometry. MultiPointOpenLayers. Geometry. MultiPolygonOpenLayers. Handler.PathOpenLayers. Handler. PointOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Tile. ImageOpenLayers. Tile.WFS
D
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
E
 EVENT_TYPES, OpenLayers.Map
K
 KEY_BACKSPACE, OpenLayers. Event
 KEY_DELETE, OpenLayers. Event
 KEY_DOWN, OpenLayers. Event
 KEY_ESC, OpenLayers. Event
 KEY_EVENTS, OpenLayers. handler. Keyboard
 KEY_LEFT, OpenLayers. Event
 KEY_RETURN, OpenLayers. Event
 KEY_RIGHT, OpenLayers. Event
 KEY_TAB, OpenLayers. Event
 KEY_UP, OpenLayers. Event
S
 style, OpenLayers. Feature. Vector. OpenLayers. Feature. Vector
T
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
V
 VERSION_NUMBER, OpenLayers
Z
 Z_INDEX_BASE, OpenLayers.Map
+ +
{String} OpenLayers.Format
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
{String} Name of class.
{String} Name of class.
+ + + +
{Object} Hashtable of default parameter key/value pairs
+ + + +
{Array} supported application event types
+ + + +
{int}
{int}
{int}
{int}
keydown, keypress, keyup
{int}
{int}
{int}
{int}
{int}
+ + + +
OpenLayers features can have a number of style attributes.
+ + + +
{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 index 214071a276..e3f7288da1 100644 --- a/index/Files.html +++ b/index/Files.html @@ -1,17 +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
+ + + + + + +
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 Base Types
+ +
Basic types in OpenLayers are described here.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Functions.html b/index/Functions.html index b5f2cd5507..e3f6cf31d8 100644 --- a/index/Functions.html +++ b/index/Functions.html @@ -1,57 +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
$#!
 _getScriptLocation, OpenLayers
A
 addResults, OpenLayers. Tile.WFS
 assert, OpenLayers. Console
 atPoint, OpenLayers. Feature. Vector
B
 Bounds, OpenLayers. Bounds. OpenLayers
 Box, OpenLayers. Marker. Box. OpenLayers. Marker
C
 calculateBounds, OpenLayers. Geometry. Point
 checkImgURL, OpenLayers. Tile. Image
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. Feature. VectorOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 create, OpenLayers. Class
 createMarker, OpenLayers. Feature
 createPopup, OpenLayers. Feature
D
 debug, OpenLayers. Console
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 destroyMarker, OpenLayers. Feature
 destroyPopup, OpenLayers. Feature
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display
OpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.Box
 distanceTo, OpenLayers. Geometry. Point
 draw
OpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
E
 equals
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. Pixel
 error, OpenLayers. Console
F
 Feature, OpenLayers. Feature. OpenLayers
 Format, OpenLayers. Format. OpenLayers
G
 Geometry, OpenLayers. Geometry. OpenLayers
 getArea, OpenLayers. Geometry. Polygon
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
H
 hide, OpenLayers. Popup
I
 Icon, OpenLayers. Icon. OpenLayers
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 inflate, OpenLayers. Marker
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
L
 Layer, OpenLayers. Layer. OpenLayers
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 LonLat, OpenLayers. LonLat. OpenLayers
- -
_getScriptLocation: function ()
Return the path to this script.
- - - -
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
assert: function()
Tests that an expression is true.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
- - - -
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.Feature An exact clone of this OpenLayers.Feature
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
Creates a Geometry Collection -- a list of geoms.
create: function()
Create an OpenLayers style class
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
- - - -
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function(setNewBaseLayer)
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy: function()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
destroyMarker: function()
Destroys marker.
destroyPopup: function()
Destroys the popup created via createPopup.
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
distanceTo: function(point)
draw: function(px)
Move the div to the given pixel.
draw: function(px)
Calls draw on the icon, and returns that output.
draw: function(px,
sz)
draw: function(px)
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
- - - -
equals:function(bounds)
Test a two bounds for equivalence
equals:function(geom)
equals:function(px)
Determine whether one pixel is equivalent to another
error: function()
Writes a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called.
- - - -
Constructor for features.
Instances of this class are not useful.
- - - -
Creates a geometry object.
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
getBoundsFromBaseLayer: function(position)
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
getLayer: function(id)
Get a layer based on its id
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
groupEnd: function()
Closes the most recently opened block created by a call to OpenLayers.Console.group
- - - -
hide: function()
- - - -
Creates an icon, which is an image tag in a div.
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
inflate: function(inflate)
info: function()
Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
- - - -
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
log: function()
Log an object in the console.
Create a new OpenLayers.LonLat instance
- -
Generated by Natural Docs
+ + + + + + +
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
 _removeElementObservers, OpenLayers. Event
A
 activate
OpenLayers. ControlOpenLayers. HandlerOpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers. Handler. Point
 add, OpenLayers. Pixel
 addComponent, OpenLayers. Geometry. Collection
 addComponents, OpenLayers. Geometry. Collection
 addLayer, OpenLayers.Map
 addLayers, OpenLayers.Map
 addMarker, OpenLayers. Layer. Markers
 addPoint
OpenLayers. Geometry. MultiPointOpenLayers. Handler.Path
 addResults, OpenLayers. Tile.WFS
 ArgParser, OpenLayers. Control. ArgParser. OpenLayers. Control
 assert, OpenLayers. Console
 atPoint, OpenLayers. Feature. Vector
 attachToElement, OpenLayers. Events
B
 Bounds, OpenLayers. Bounds. OpenLayers
 Box, OpenLayers. Marker. Box. OpenLayers. Marker
C
 calculateBounds
OpenLayers. Geometry. CollectionOpenLayers. Geometry. Point
 callback, OpenLayers. Handler
 cancel, OpenLayers. Handler. Point
 checkImgURL, OpenLayers. Tile. Image
 checkModifiers, OpenLayers. Handler
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clearFeatures, OpenLayers. Layer. GeoRSS
 clearMarkers, OpenLayers. Layer. Markers
 click, OpenLayers. Handler.Drag
 clone
OpenLayers. BoundsOpenLayers. Feature. VectorOpenLayers. Geometry. CollectionOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 conigureLayers, OpenLayers. Control. ArgParser
 Control, OpenLayers. Control. OpenLayers
 create, OpenLayers. Class
 createFeature
OpenLayers. Handler.PathOpenLayers. Handler. Point
 createMarker, OpenLayers. Feature
 createPopup, OpenLayers. Feature
+ +
_getScriptLocation: function ()
Return the path to this script.
_removeElementObservers: function(elementObservers)
Private.
+ + + +
activate: function ()
{Boolean}
activate: function()
Turn on the handler.
activate: function()
Activate the handler.
activate: function()
Turn on the handler.
activate: function()
activate: function (evt)
activate: function()
turn on the handler
add:function(x,
y)
addComponent: function(component,
index)
Add a new component (geometry) to the collection.
addComponents: function(components)
Add components to this geometry.
addLayer: function (layer)
addLayers: function (layers)
addMarker: function(marker)
addPoint: function(point,
index)
Wrapper for OpenLayers.Geometry.Collection.addComponent
addPoint: function()
Private.
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
assert: function()
Tests that an expression is true.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
attachToElement: function (element)
+ + + +
Construct a new bounds object.
+ + + +
calculateBounds: function()
Recalculate the bounds by iterating through the components and calling calling extendBounds() on each item
calculateBounds: function ()
Create a new Bounds based on the lon/lat
callback: function (name,
args)
trigger the control’s named callback with the given arguments
cancel: function()
Finish the geometry and call the “cancel” callback.
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.
checkModifiers: function (evt)
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.
clearFeatures: function()
Destroy all features in this layer.
clearMarkers: function()
click: function (evt)
The drag handler captures the click event.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
OpenLayers.Feature An exact clone of this OpenLayers.Feature
clone: function()
Clone this geometry.
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
Creates a Geometry Collection -- a list of geoms.
As soon as all the layers are loaded, cycle through them and hide or show them.
Create an OpenLayers Control.
create: function()
Create an OpenLayers style class
createFeature: function()
Private.
createFeature: function()
Add temporary features
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Functions2.html b/index/Functions2.html index 8820237791..6672ae2627 100644 --- a/index/Functions2.html +++ b/index/Functions2.html @@ -1,49 +1,25 @@ - - -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
M
 Map, OpenLayers. Map. OpenLayers
 Marker, OpenLayers. Marker. OpenLayers
 move, OpenLayers. Geometry. Point
 moveTo
OpenLayers.IconOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
O
 onclick, OpenLayers. Popup
 ondblclick, OpenLayers. Popup
 onmousedown, OpenLayers. Popup
 onmousemove, OpenLayers. Popup
 onmouseout, OpenLayers. Popup
 onmouseup, OpenLayers. Popup
 onScreen
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Marker.Box
 oppositeQuadrant, OpenLayers. Bounds
P
 Pixel, OpenLayers. Pixel. OpenLayers
 Point, OpenLayers. Geometry. Point. OpenLayers. Geometry
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 Popup, OpenLayers. Popup. OpenLayers
 processXMLNode, OpenLayers. Feature.WFS
R
 read, OpenLayers. Format
 registerEvents, OpenLayers. Popup
 requestSuccess, OpenLayers. Tile.WFS
S
 setBackgroundColor, OpenLayers. Popup
 setBorder
OpenLayers. Marker.BoxOpenLayers. Popup
 setContentHTML, OpenLayers. Popup
 setOpacity
OpenLayers.IconOpenLayers. MarkerOpenLayers. Popup
 setOptions, OpenLayers.Map
 setSize
OpenLayers.IconOpenLayers. Popup
 show, OpenLayers. Popup
 Size, OpenLayers. Size. OpenLayers
T
 Tile, OpenLayers. Tile. OpenLayers
 time, OpenLayers. Console
 toggle, OpenLayers. Popup
 toShortString, OpenLayers. Geometry. Point
 toState, OpenLayers. Feature. Vector
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 unloadDestroy, OpenLayers.Map
 updatePosition, OpenLayers. Popup
V
 Vector
OpenLayers. Feature. Vector. OpenLayers. FeatureOpenLayers. Layer. Vector. OpenLayers. Layer
 visible, OpenLayers. Popup
W
 warn, OpenLayers. Console
 WFS
OpenLayers. Feature. WFS. OpenLayers. FeatureOpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 write, OpenLayers. Format
- -
Constructor for a new OpenLayers.Map instance.
move: function(x,
y)
Moves a point in place
moveTo: function (px)
move icon to passed in px.
moveTo: function (px)
Move the marker to the new location.
moveTo: function(px)
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
Create a new MultiPoint Geometry
- - - -
onclick: function (evt)
Ignore clicks, but allowing default browser handling
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
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.
Create a popup.
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
- - - -
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
registerEvents:function()
Registers events on the popup.
requestSuccess:function(request)
Called on return from request succcess.
- - - -
setBackgroundColor:function(color)
setBorder: function (color,
width)
Allow the user to change the box’s color and border width
setBorder:function(border)
setContentHTML:function(contentHTML)
setOpacity: function(opacity)
Change the icon’s opacity
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOpacity:function(opacity)
setOptions: function(options)
Change the map options
setSize: function(size)
setSize:function(size)
show: function()
Create an instance of OpenLayers.Size
- - - -
Constructor for a new OpenLayers.Tile instance.
time: function()
Creates a new timer under the given name.
toggle: function()
toShortString: function()
{String} Shortened String representation of Point object.
toState: function(state)
Sets the new state
toString:function()
Return a readable string version of the lonlat
toString:function()
Cast this object into a string
toString:function()
Return the string representation of a size object
trace: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
- - - -
Function that is called to destroy the map on page unload.
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
- - - -
Create a vector feature.
Create a new vector layer
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
- - - -
warn: function()
Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
Create a WFS feature.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new WMS layer object
write: function(object)
Accept an object, and return a string.
- -
Generated by Natural Docs
+ + + + + + +
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
D
 dblclick
OpenLayers. Handler. FeatureOpenLayers. Handler.PathOpenLayers. Handler. Point
 deactivate
OpenLayers. ControlOpenLayers. HandlerOpenLayers. Handler.DragOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers. Handler. Point
 debug, OpenLayers. Console
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. ControlOpenLayers. EventsOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. HandlerOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. GeoRSSOpenLayers. Layer. ImageOpenLayers. Layer. MarkersOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 destroyFeature
OpenLayers. Handler.PathOpenLayers. Handler. Point
 destroyMarker, OpenLayers. Feature
 destroyPopup, OpenLayers. Feature
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display
OpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.Box
 distanceTo, OpenLayers. Geometry. Point
 Drag, OpenLayers. Handler. Drag. OpenLayers. Handler
 draw
OpenLayers. ControlOpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawFeature
OpenLayers. Handler.PathOpenLayers. Handler. Point
 drawMarker, OpenLayers. Layer. Markers
E
 element, OpenLayers. Event
 equals
OpenLayers. BoundsOpenLayers. Geometry. CollectionOpenLayers. Geometry. PointOpenLayers. PixelOpenLayers.Size
 error, OpenLayers. Console
 Events, OpenLayers. Events. OpenLayers
F
 Feature
OpenLayers. Feature. OpenLayersOpenLayers. Handler. Feature. OpenLayers. Handler
 finalize, OpenLayers. Handler. Point
 findElement, OpenLayers. Event
 Format, OpenLayers. Format. OpenLayers
 freehandMode, OpenLayers. Handler.Path
+ +
dblclick: function(evt)
Capture double-clicks.
dblclick: function(evt)
Private.
dblclick: function(evt)
Handle double clicks.
deactivate: function ()
{Boolean}
deactivate: function()
Turn off the handler.
deactivate: function()
Deactivate the handler.
deactivate: function()
deactivate: function (evt)
deactivate: function()
turn off the handler
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 ()
destroy: function ()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
Destroy this geometry.
destroy: function ()
Destroy this geometry.
destroy: function ()
destroy: function()
destroy: function()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function(setNewBaseLayer)
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
destroy: function()
destroy: function()
Destroy this layer
destroy: function()
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy: function()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
destroyFeature: function()
Private.
destroyFeature: function()
Destroy the temporary geometries
destroyMarker: function()
Destroys marker.
destroyPopup: function()
Destroys the popup created via createPopup.
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
distanceTo: function(point)
Returns OpenLayers.Handler.Drag
draw: function (px)
draw: function(px)
Move the div to the given pixel.
draw: function(px)
Calls draw on the icon, and returns that output.
draw: function(px,
sz)
draw: function(px)
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
drawFeature: function()
Private.
drawFeature: function()
Render features on the temporary layer.
drawMarker: function(marker)
Private.
+ + + +
element: function(event)
Cross browser event element detection.
equals:function(bounds)
Test a two bounds for equivalence
equals: function(geometry)
Tests for equivalent geometries
equals:function(geom)
equals:function(px)
Determine whether one pixel is equivalent to another
equals:function(sz)
Determine where this size is equal 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.
Construct an OpenLayers.Events object.
+ + + +
Constructor for features.
finalize: function()
Finish the geometry and call the “done” callback.
findElement: function(event,
tagName)
Instances of this class are not useful.
freehandMode: function(evt)
Private.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Functions3.html b/index/Functions3.html new file mode 100644 index 0000000000..c45ca65b4a --- /dev/null +++ b/index/Functions3.html @@ -0,0 +1,41 @@ + + +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
G
 Geometry, OpenLayers. Geometry. OpenLayers
 geometryClone
OpenLayers. Handler.PathOpenLayers. Handler. Point
 GeoRSS, OpenLayers. Layer. GeoRSS. OpenLayers. Layer
 getArea
OpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. Polygon
 getBoundsFromBaseLayer, OpenLayers.Tile
 getComponentsString, OpenLayers. Geometry. Collection
 getLayer, OpenLayers.Map
 getLayerIndex, OpenLayers.Map
 getLength
OpenLayers. GeometryOpenLayers. Geometry. Collection
 getMousePosition, OpenLayers. Events
 getNumLayers, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupEnd, OpenLayers. Console
H
 handleBrowserEvent, OpenLayers. Events
 handleKeyEvent, OpenLayers. handler. Keyboard
 Handler, OpenLayers. Handler. OpenLayers
 hide, OpenLayers. Popup
I
 Icon, OpenLayers. Icon. OpenLayers
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 inflate, OpenLayers. Marker
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
 isLeftClick, OpenLayers. Event
K
 Keyboard, OpenLayers. handler. Keyboard. OpenLayers. Handler
L
 Layer, OpenLayers. Layer. OpenLayers
 LineString, OpenLayers. Geometry. LineString. OpenLayers. Geometry
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 LonLat, OpenLayers. LonLat. OpenLayers
M
 Map, OpenLayers. Map. OpenLayers
 Marker, OpenLayers. Marker. OpenLayers
 markerClick, OpenLayers. Layer. GeoRSS
 Markers, OpenLayers. Layer. Markers. OpenLayers. Layer
 modifyFeature, OpenLayers. Handler.Path
 mousedown
OpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. Handler.PathOpenLayers. Handler. Point
 mousemove
OpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. Handler. MouseWheelOpenLayers. Handler.PathOpenLayers. Handler. Point
 mouseout, OpenLayers. Handler.Drag
 mouseup
OpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. Handler.PathOpenLayers. Handler. Point
 MouseWheel, OpenLayers. Handler. MouseWheel. OpenLayers. Handler
 move
OpenLayers. Geometry. CollectionOpenLayers. Geometry. Point
 moveTo
OpenLayers. ControlOpenLayers.IconOpenLayers. Layer. MarkersOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
 MultiPolygon, OpenLayers. Geometry. MultiPolygon. OpenLayers. Geometry
O
 observe, OpenLayers. Event
 onclick, OpenLayers. Popup
 ondblclick, OpenLayers. Popup
 onmousedown, OpenLayers. Popup
 onmousemove, OpenLayers. Popup
 onmouseout, OpenLayers. Popup
 onmouseup, OpenLayers. Popup
 onScreen
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Marker.Box
 onWheelEvent, OpenLayers. Handler. MouseWheel
 oppositeQuadrant, OpenLayers. Bounds
+ +
Creates a geometry object.
geometryClone: function()
Private.
geometryClone: function()
Return a clone of the relevant geometry.
Create a GeoRSS Layer.
getArea: function()
Calculate the area of this geometry.
getArea: function()
Calculate the area of this geometry.
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.
getComponentsString: function()
Get a string representing the components for this collection
getLayer: function(id)
Get a layer based on its id
getLayerIndex: function (layer)
@param {OpenLayers.Layer} layer
getLength: function()
Calculate the length of this geometry.
getLength: function()
Calculate the length of this geometry
getMousePosition: function (evt)
Private
getNumLayers: function ()
Return: {Int} The number of layers attached to the map.
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
+ + + +
handleBrowserEvent: function (evt)
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
handleKeyEvent: function (evt)
Construct a handler.
hide: function()
+ + + +
Creates an icon, which is an image tag in a div.
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
inflate: function(inflate)
info: function()
Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
isLeftClick: function(event)
Determine whether event was caused by a left click.
+ + + + + + + +
Create a new LineString geometry
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.
markerClick: function(evt)
Create a Markers layer.
modifyFeature: function()
Private.
mousedown: function (evt)
Handle mousedown events
mousedown: function(evt)
Handle mouse down.
mousedown: function(evt)
Private.
mousedown: function(evt)
Handle mouse down.
mousemove: function (evt)
Handle mousemove events
mousemove: function(evt)
Handle mouse moves.
mousemove: function (evt)
Update the stored mousePosition on every move.
mousemove: function (evt)
Private.
mousemove: function (evt)
Handle mouse move.
mouseout: function (evt)
Handle mouseout events
mouseup: function (evt)
Handle mouseup events
mouseup: function(evt)
Handle mouse up.
mouseup: function (evt)
Private.
mouseup: function (evt)
Handle mouse up.
move: function(x,
y)
Moves a collection in place
move: function(x,
y)
Moves a point in place
moveTo: function (px)
moveTo: function (px)
move icon to passed in px.
moveTo:function(bounds,
zoomChanged,
dragging)
moveTo: function (px)
Move the marker to the new location.
moveTo: function(px)
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
Create a new MultiPoint Geometry
Create a new MultiPolygon geometry
+ + + +
observe: function(elementParam,
name,
observer,
useCapture)
onclick: function (evt)
Ignore clicks, but allowing default browser handling
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
onWheelEvent: function(e)
Catch the wheel event and handle it xbrowserly
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Functions4.html b/index/Functions4.html new file mode 100644 index 0000000000..b767047b2f --- /dev/null +++ b/index/Functions4.html @@ -0,0 +1,41 @@ + + +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
P
 parseData, OpenLayers. Layer. GeoRSS
 Path, OpenLayers. Handler. Path. OpenLayers. Handler
 Pixel, OpenLayers. Pixel. OpenLayers
 Point
OpenLayers. Geometry. Point. OpenLayers. GeometryOpenLayers. Handler. Point. OpenLayers. Handler
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 Popup, OpenLayers. Popup. OpenLayers
 processXMLNode, OpenLayers. Feature.WFS
R
 raiseLayer, OpenLayers.Map
 read
OpenLayers. FormatOpenLayers. Format.WKT
 redraw, OpenLayers. Layer. Markers
 register
OpenLayers. EventsOpenLayers. Handler
 registerEvents, OpenLayers. Popup
 registerPriority, OpenLayers. Events
 remove, OpenLayers. Events
 removeComponent
OpenLayers. Geometry. CollectionOpenLayers. Geometry. LineString
 removeComponents, OpenLayers. Geometry. Collection
 removeLayer, OpenLayers.Map
 removeMarker, OpenLayers. Layer. Markers
 requestSuccess, OpenLayers. Tile.WFS
S
 select, OpenLayers. Handler. Feature
 setBackgroundColor, OpenLayers. Popup
 setBorder
OpenLayers. Marker.BoxOpenLayers. Popup
 setCenter, OpenLayers. Control. ArgParser
 setContentHTML, OpenLayers. Popup
 setLayerIndex, OpenLayers.Map
 setLayerZIndex, OpenLayers.Map
 setMap
OpenLayers. ControlOpenLayers. Control. ArgParserOpenLayers. Handler
 setOpacity
OpenLayers.IconOpenLayers. MarkerOpenLayers. Popup
 setOptions, OpenLayers.Map
 setSize
OpenLayers.IconOpenLayers. Popup
 show, OpenLayers. Popup
 Size, OpenLayers. Size. OpenLayers
 stop, OpenLayers. Event
 stopObserving, OpenLayers. Event
 stopObservingElement, OpenLayers. Event
T
 Tile, OpenLayers. Tile. OpenLayers
 time, OpenLayers. Console
 toggle, OpenLayers. Popup
 toShortString, OpenLayers. Geometry. Point
 toState, OpenLayers. Feature. Vector
 toString
OpenLayers. GeometryOpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
 trigger, OpenLayers. Control. ZoomToMaxExtent
 triggerEvent, OpenLayers. Events
U
 unloadCache, OpenLayers. Event
 unloadDestroy, OpenLayers.Map
 unregister
OpenLayers. EventsOpenLayers. Handler
 updatePosition, OpenLayers. Popup
V
 Vector
OpenLayers. Feature. Vector. OpenLayers. FeatureOpenLayers. Layer. Vector. OpenLayers. Layer
 visible, OpenLayers. Popup
W
 warn, OpenLayers. Console
 WFS
OpenLayers. Feature. WFS. OpenLayers. FeatureOpenLayers. Tile. WFS. OpenLayers.Tile
 WKT, OpenLayers. Format. WKT. OpenLayers. Format
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 write
OpenLayers. FormatOpenLayers. Format.WKT
+ +
parseData: function(ajaxRequest)
Parse the data returned from the Events call.
Create a new path hander
Create a new OpenLayers.Pixel instance
Construct a point geometry.
Create a new point handler.
Constructor for a Polygon geometry.
Create a popup.
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
+ + + +
raiseLayer: function (layer,
delta)
Change the index of the given layer by delta.
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
read: function(wkt)
Deserialize a WKT string and return an OpenLayers.Feature.Vector or an array of OpenLayers.Feature.Vector.
redraw: function()
clear all the marker div’s from the layer and then redraw all of them.
register: function (type,
obj,
func)
Register an event on the events object.
register: function (name,
method)
register an event on the map
registerEvents:function()
Registers events on the popup.
registerPriority: function (type,
obj,
func)
remove: function(type)
Remove all listeners for a given event type.
removeComponent: function(component)
Remove a component from this geometry.
removeComponent: function(point)
Only allows removal of a point if there are three or more points in the linestring.
removeComponents: function(components)
Remove components from this geometry.
removeLayer: function(layer,
setNewBaseLayer)
Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map’s internal list of layers, setting the layer’s map property to null.
removeMarker: function(marker)
requestSuccess:function(request)
Called on return from request succcess.
+ + + +
select: function(type,
evt)
Trigger the appropriate callback if a feature is under the mouse.
setBackgroundColor:function(color)
setBorder: function (color,
width)
Allow the user to change the box’s color and border width
setBorder:function(border)
setCenter: function()
As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.
setContentHTML:function(contentHTML)
setLayerIndex: function (layer,
idx)
Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.
setLayerZIndex: function (layer,
zIdx)
Private.
setMap: function(map)
Set the map property for the control.
setMap: function(map)
Set the map property for the control.
setMap: function (map)
setOpacity: function(opacity)
Change the icon’s opacity
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOpacity:function(opacity)
setOptions: function(options)
Change the map options
setSize: function(size)
setSize:function(size)
show: function()
Create an instance of OpenLayers.Size
stop: function(event,
allowDefault)
Stops an event from propagating.
stopObserving: function(elementParam,
name,
observer,
useCapture)
stopObservingElement: function(elementParam)
Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.
+ + + +
Constructor for a new OpenLayers.Tile instance.
time: function()
Creates a new timer under the given name.
toggle: function()
toShortString: function()
{String} Shortened String representation of Point object.
toState: function(state)
Sets the new state
toString: function()
Returns the Well-Known Text representation of a geometry
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.
trigger: function()
Do the zoom.
triggerEvent: function (type,
evt)
Trigger a specified registered event
+ + + +
unloadCache: function()
Cycle through all the element entries in the events cache and call stopObservingElement on each.
Function that is called to destroy the map on page unload.
unregister: function (type,
obj,
func)
unregister: function (name,
method)
unregister an event from the map
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
+ + + +
Create a vector feature.
Create a new vector layer
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
+ + + +
warn: function()
Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
Create a WFS feature.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new parser for WKT
Create a new WMS layer object
write: function(object)
Accept an object, and return a string.
write: function(features)
Serialize a feature or array of features into a WKT string.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General.html b/index/General.html index 34e6a412cd..6c4416b333 100644 --- a/index/General.html +++ b/index/General.html @@ -1,37 +1,29 @@ - - -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
 active
 addResults, OpenLayers. Tile.WFS
 aspectRatio, OpenLayers. Layer. Image
 assert, OpenLayers. Console
 atPoint, OpenLayers. Feature. Vector
 attributes, OpenLayers. Feature. Vector
B
 backgroundColor, OpenLayers. Popup
 baseLayer, OpenLayers.Map
 border, OpenLayers. Popup
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers. Marker.BoxOpenLayers.Tile
 Bounds, OpenLayers. Bounds. OpenLayers
 Box, OpenLayers. Marker. Box. OpenLayers. Marker
C
 calculateBounds, OpenLayers. Geometry. Point
 calculateOffset, OpenLayers.Icon
 center, OpenLayers.Map
 checkImgURL, OpenLayers. Tile. Image
 CLASS_NAME
OpenLayers. ConsoleOpenLayers. FormatOpenLayers. Geometry. MultiLineStringOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clone
OpenLayers. BoundsOpenLayers. Feature. VectorOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 Constants
OpenLayersOpenLayers. ConsoleOpenLayers. Feature. VectorOpenLayers. FormatOpenLayers. Geometry. MultiLineStringOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.Map
 contentDiv, OpenLayers. Popup
 contentHTML, OpenLayers. Popup
 controls, OpenLayers.Map
 create, OpenLayers. Class
 createMarker, OpenLayers. Feature
 createPopup, OpenLayers. Feature
D
 data, OpenLayers. Feature
 debug, OpenLayers. Console
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 destroyMarker, OpenLayers. Feature
 destroyPopup, OpenLayers. Feature
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display
OpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.Box
 displayOutsideMaxExtent, OpenLayers. Layer
 distanceTo, OpenLayers. Geometry. Point
 div
OpenLayers.MapOpenLayers. Marker.BoxOpenLayers. Popup
 draw
OpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawn, OpenLayers.Tile
E
 equals
OpenLayers. BoundsOpenLayers. Geometry. PointOpenLayers. Pixel
 error, OpenLayers. Console
 EVENT_TYPES, OpenLayers.Map
 events
OpenLayers. FeatureOpenLayers.MapOpenLayers. MarkerOpenLayers. Popup
 extent, OpenLayers. Layer. Image
- -
_getScriptLocation: function ()
Return the path to this script.
{String} Relative path of this script.
- - - -
{boolean} null
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
{Number} The ratio of height/width represented by a single pixel in the graphic
assert: function()
Tests that an expression is true.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
{Object}
- - - -
{String}
{String}
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
Construct a new bounds object.
- - - -
calculateBounds: function ()
Create a new Bounds based on the lon/lat
{OpenLayers.Pixel} Function to calculate the offset (based on the size)
{OpenLayers.LonLat} The current center of the map
checkImgURL: function ()
Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime.
{String} OpenLayers.Format
Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
OpenLayers.Feature An exact clone of this OpenLayers.Feature
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
Creates a Geometry Collection -- a list of geoms.
{DOMElement}
{String}
{Array(OpenLayers.Control)} List of controls associated with the map
create: function()
Create an OpenLayers style class
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
- - - -
{Object}
debug: function()
Writes a message to the console, including a hyperlink to the line where it was called.
{Object} Hashtable of default parameter key/value pairs
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function(setNewBaseLayer)
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy: function()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
destroyMarker: function()
Destroys marker.
destroyPopup: function()
Destroys the popup created via createPopup.
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
distanceTo: function(point)
{DOMElement} The element that contains the map
{DOMElement}
{DOMElement}
draw: function(px)
Move the div to the given pixel.
draw: function(px)
Calls draw on the icon, and returns that output.
draw: function(px,
sz)
draw: function(px)
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
{Boolean} false
- - - -
equals:function(bounds)
Test a two bounds for equivalence
equals:function(geom)
equals:function(px)
Determine whether one pixel is equivalent to another
error: function()
Writes a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called.
{Array} supported application event types
{OpenLayers.Events}
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{OpenLayers.Events}
{OpenLayers.Bounds} The image bounds in map units
- -
Generated by Natural Docs
+ + + + + + +
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
 _removeElementObservers, OpenLayers. Event
 _scriptName, OpenLayers
A
 activate
OpenLayers. ControlOpenLayers. HandlerOpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers. Handler. Point
 active
OpenLayers. ControlOpenLayers. Handler
 add, OpenLayers. Pixel
 addComponent, OpenLayers. Geometry. Collection
 addComponents, OpenLayers. Geometry. Collection
 addLayer, OpenLayers.Map
 addLayers, OpenLayers.Map
 addMarker, OpenLayers. Layer. Markers
 addPoint
OpenLayers. Geometry. MultiPointOpenLayers. Handler.Path
 addResults, OpenLayers. Tile.WFS
 ArgParser, OpenLayers. Control. ArgParser. OpenLayers. Control
 aspectRatio, OpenLayers. Layer. Image
 assert, OpenLayers. Console
 atPoint, OpenLayers. Feature. Vector
 attachToElement, OpenLayers. Events
 attributes, OpenLayers. Feature. Vector
B
 backgroundColor, OpenLayers. Popup
 baseLayer, OpenLayers.Map
 border, OpenLayers. Popup
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers. Marker.BoxOpenLayers.Tile
 Bounds, OpenLayers. Bounds. OpenLayers
 Box, OpenLayers. Marker. Box. OpenLayers. Marker
C
 calculateBounds
OpenLayers. Geometry. CollectionOpenLayers. Geometry. Point
 calculateOffset, OpenLayers.Icon
 callback, OpenLayers. Handler
 cancel, OpenLayers. Handler. Point
 center, OpenLayers.Map
 checkImgURL, OpenLayers. Tile. Image
 checkModifiers, OpenLayers. Handler
 CLASS_NAME
OpenLayers. ConsoleOpenLayers. FormatOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. LineStringOpenLayers. Geometry. MultiLineStringOpenLayers. Geometry. MultiPointOpenLayers. Geometry. MultiPolygonOpenLayers. Handler.PathOpenLayers. Handler. PointOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clear
OpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 clearFeatures, OpenLayers. Layer. GeoRSS
 clearMarkers, OpenLayers. Layer. Markers
 click, OpenLayers. Handler.Drag
 clone
OpenLayers. BoundsOpenLayers. Feature. VectorOpenLayers. Geometry. CollectionOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer.WMSOpenLayers. PixelOpenLayers.Size
 Collection, OpenLayers. Geometry. Collection. OpenLayers. Geometry
 components, OpenLayers. Geometry. Collection
 conigureLayers, OpenLayers. Control. ArgParser
 Constants
OpenLayersOpenLayers. ConsoleOpenLayers. EventOpenLayers. Feature. VectorOpenLayers. FormatOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. LineStringOpenLayers. Geometry. MultiLineStringOpenLayers. Geometry. MultiPointOpenLayers. Geometry. MultiPolygonOpenLayers. handler. KeyboardOpenLayers. Handler.PathOpenLayers. Handler. PointOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 contentDiv, OpenLayers. Popup
 contentHTML, OpenLayers. Popup
 control, OpenLayers. Handler
 Control, OpenLayers. Control. OpenLayers
 controls, OpenLayers.Map
 create, OpenLayers. Class
 createFeature
OpenLayers. Handler.PathOpenLayers. Handler. Point
 createMarker, OpenLayers. Feature
 createPopup, OpenLayers. Feature
+ +
_getScriptLocation: function ()
Return the path to this script.
_removeElementObservers: function(elementObservers)
Private.
{String} Relative path of this script.
+ + + +
activate: function ()
{Boolean}
activate: function()
Turn on the handler.
activate: function()
Activate the handler.
activate: function()
Turn on the handler.
activate: function()
activate: function (evt)
activate: function()
turn on the handler
{boolean} null
Private.
add:function(x,
y)
addComponent: function(component,
index)
Add a new component (geometry) to the collection.
addComponents: function(components)
Add components to this geometry.
addLayer: function (layer)
addLayers: function (layers)
addMarker: function(marker)
addPoint: function(point,
index)
Wrapper for OpenLayers.Geometry.Collection.addComponent
addPoint: function()
Private.
addResults: function(results)
Construct new feature via layer featureClass constructor, and add to this.features.
{Number} The ratio of height/width represented by a single pixel in the graphic
assert: function()
Tests that an expression is true.
atPoint: function(lonlat,
toleranceLon,
toleranceLat)
Determins whether the feature intersects with the specified location.
attachToElement: function (element)
{Object}
+ + + +
{String}
{String}
{Number}
{OpenLayers.Bounds} The bounds of this geometry
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
Construct a new bounds object.
+ + + +
calculateBounds: function()
Recalculate the bounds by iterating through the components and calling calling extendBounds() on each item
calculateBounds: function ()
Create a new Bounds based on the lon/lat
{OpenLayers.Pixel} Function to calculate the offset (based on the size)
callback: function (name,
args)
trigger the control’s named callback with the given arguments
cancel: function()
Finish the geometry and call the “cancel” callback.
{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.
checkModifiers: function (evt)
{String} OpenLayers.Format
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} Name of class.
{String} OpenLayers.Layer.Image
{String} OpenLayers.Layer.Vector
{String} OpenLayers.Layer.WMS
{String} OpenLayers.Map
{String} Name of class.
{String} Name of class.
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.
clearFeatures: function()
Destroy all features in this layer.
clearMarkers: function()
click: function (evt)
The drag handler captures the click event.
clone:function()
Create a cloned instance of this bounds.
clone: function (obj)
OpenLayers.Feature An exact clone of this OpenLayers.Feature
clone: function()
Clone this geometry.
clone: function(obj)
{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
clone: function()
{OpenLayers.Icon} A fresh copy of the icon.
clone: function (obj)
clone: function(obj)
Create a clone of this layer
clone: function (obj)
Create a clone of this layer
clone:function()
Return a clone of this pixel object
clone:function()
Create a clone of this size object
Creates a Geometry Collection -- a list of geoms.
{Array(OpenLayers.Geometry)} The component parts of this geometry
As soon as all the layers are loaded, cycle through them and hide or show them.
{DOMElement}
{String}
Private.
Create an OpenLayers Control.
{Array(OpenLayers.Control)} List of controls associated with the map
create: function()
Create an OpenLayers style class
createFeature: function()
Private.
createFeature: function()
Add temporary features
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
createPopup: function(closeBox)
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General2.html b/index/General2.html index 82f79258ee..10efcc8959 100644 --- a/index/General2.html +++ b/index/General2.html @@ -1,41 +1,21 @@ - - -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
F
 fallThrough, OpenLayers.Map
 Feature, OpenLayers. Feature. OpenLayers
 features, OpenLayers. Tile.WFS
 fid, OpenLayers. Feature. Vector
 Format, OpenLayers. Format. OpenLayers
 frame, OpenLayers. Tile. Image
 Functions
OpenLayersOpenLayers. BoundsOpenLayers. ClassOpenLayers. ConsoleOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers. FormatOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. MultiLineStringOpenLayers. Geometry. MultiPointOpenLayers. Geometry. PointOpenLayers. Geometry. PolygonOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. LonLatOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PixelOpenLayers. PopupOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
G
 geometry, OpenLayers. Feature. Vector
 Geometry, OpenLayers. Geometry. OpenLayers
 getArea, OpenLayers. Geometry. Polygon
 getBoundsFromBaseLayer, OpenLayers.Tile
 getLayer, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupDiv, OpenLayers. Popup
 groupEnd, OpenLayers. Console
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
 handler
 hide, OpenLayers. Popup
I
 icon, OpenLayers. Marker
 Icon, OpenLayers. Icon. OpenLayers
 id
OpenLayers. FeatureOpenLayers.MapOpenLayers.Tile
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 imageDiv, OpenLayers.Icon
 imgDiv, OpenLayers. Tile. Image
 inflate, OpenLayers. Marker
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer
OpenLayers. FeatureOpenLayers.Tile
 Layer, OpenLayers. Layer. OpenLayers
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 log, OpenLayers. Console
 lonlat
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Popup
 LonLat, OpenLayers. LonLat. OpenLayers
M
 map
OpenLayers. MarkerOpenLayers. Popup
 Map, OpenLayers. Map. OpenLayers
 marker, OpenLayers. Feature
 Marker, OpenLayers. Marker. OpenLayers
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
 move, OpenLayers. Geometry. Point
 moveTo
OpenLayers.IconOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
- -
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
Constructor for features.
{Array(OpenLayers.Feature)} list of features in this tile
{String}
Instances of this class are not useful.
{DOMElement} The image element is appended to the frame.
- - - -
{OpenLayers.Geometry}
Creates a geometry object.
getArea: function()
Calculated by subtracting the areas of the internal holes from the area of the outer hole.
getBoundsFromBaseLayer: function(position)
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
getLayer: function(id)
Get a layer based on its id
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
{DOMElement}
groupEnd: function()
Closes the most recently opened block created by a call to OpenLayers.Console.group
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
- - - -
{Number} height
{OpenLayers.Handler} null
hide: function()
- - - -
{OpenLayers.Icon}
Creates an icon, which is an image tag in a div.
{String}
{String} Unique identifier for the map
{String} null
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
{DOMElement}
{DOMElement} The div element which wraps the image.
inflate: function(inflate)
info: function()
Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
{Boolean} The layer is a base layer.
{Boolean} The layer is a base layer.
- - - -
{OpenLayers.Layer}
{OpenLayers.Layer} layer the tile is attached to
{HTMLDivElement} The element that contains the layers.
{OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom)
{Array(OpenLayers.Layer)} Ordered list of layers in the map
{Number}
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
log: function()
Log an object in the console.
{OpenLayers.LonLat}
{OpenLayers.LonLat} location of object
{OpenLayers.LonLat}
Create a new OpenLayers.LonLat instance
- - - -
{OpenLayers.Map}
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
Constructor for a new OpenLayers.Map instance.
{OpenLayers.Marker}
{OpenLayers.Bounds}
{OpenLayers.Bounds} The maximum extent for the map.
{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
{Number}
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds}
{Number}
{Number}
{Number}
move: function(x,
y)
Moves a point in place
moveTo: function (px)
move icon to passed in px.
moveTo: function (px)
Move the marker to the new location.
moveTo: function(px)
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
Create a new MultiPoint Geometry
- - - -
{Integer}
{Integer} Number of zoom levels for 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
D
 data, OpenLayers. Feature
 dblclick
OpenLayers. Handler. FeatureOpenLayers. Handler.PathOpenLayers. Handler. Point
 deactivate
OpenLayers. ControlOpenLayers. HandlerOpenLayers. Handler.DragOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers. Handler. Point
 debug, OpenLayers. Console
 DEFAULT_PARAMS, OpenLayers. Layer.WMS
 defaultIcon, OpenLayers. Marker
 destroy
OpenLayers. ControlOpenLayers. EventsOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. HandlerOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. GeoRSSOpenLayers. Layer. ImageOpenLayers. Layer. MarkersOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers.MapOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 destroyAllFeatures, OpenLayers. Tile.WFS
 destroyFeature
OpenLayers. Handler.PathOpenLayers. Handler. Point
 destroyMarker, OpenLayers. Feature
 destroyPopup, OpenLayers. Feature
 dir, OpenLayers. Console
 dirxml, OpenLayers. Console
 display
OpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.Box
 displayClass, OpenLayers. Control
 displayOutsideMaxExtent, OpenLayers. Layer
 distanceTo, OpenLayers. Geometry. Point
 div
OpenLayers. ControlOpenLayers.MapOpenLayers. Marker.BoxOpenLayers. Popup
 Drag, OpenLayers. Handler. Drag. OpenLayers. Handler
 dragging, OpenLayers. Handler.Drag
 draw
OpenLayers. ControlOpenLayers.IconOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 drawFeature
OpenLayers. Handler.PathOpenLayers. Handler. Point
 drawing, OpenLayers. Handler. Point
 drawMarker, OpenLayers. Layer. Markers
 drawn
OpenLayers. Layer. MarkersOpenLayers.Tile
E
 element
OpenLayers. EventOpenLayers. Events
 equals
OpenLayers. BoundsOpenLayers. Geometry. CollectionOpenLayers. Geometry. PointOpenLayers. PixelOpenLayers.Size
 error, OpenLayers. Console
 EVENT_TYPES, OpenLayers.Map
 eventHandler, OpenLayers. Events
 eventListener, OpenLayers. handler. Keyboard
 events
OpenLayers. FeatureOpenLayers.MapOpenLayers. MarkerOpenLayers. Popup
 Events
OpenLayersOpenLayers. Events. OpenLayers
 eventTypes, OpenLayers. Events
 extent, OpenLayers. Layer. Image
+ +
{Object}
dblclick: function(evt)
Capture double-clicks.
dblclick: function(evt)
Private.
dblclick: function(evt)
Handle double clicks.
deactivate: function ()
{Boolean}
deactivate: function()
Turn off the handler.
deactivate: function()
Deactivate the handler.
deactivate: function()
deactivate: function (evt)
deactivate: function()
turn off the handler
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 ()
destroy: function ()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
Destroy this geometry.
destroy: function ()
Destroy this geometry.
destroy: function ()
destroy: function()
destroy: function()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function(setNewBaseLayer)
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
destroy: function()
destroy: function()
Destroy this layer
destroy: function()
destroy: function()
Destroy this layer
destroy: function()
Destroy this layer
destroy:function()
Destroy this map
destroy: function()
destroy: function()
nullify references to prevent circular references and memory leaks
destroy:function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroy: function()
nullify references to prevent circular references and memory leaks
destroyAllFeatures: function()
Iterate through and call destroy() on each feature, removing it from the local array
destroyFeature: function()
Private.
destroyFeature: function()
Destroy the temporary geometries
destroyMarker: function()
Destroys marker.
destroyPopup: function()
Destroys the popup created via createPopup.
dir: function()
Prints an interactive listing of all properties of the object.
dirxml: function()
Prints the XML source tree of an HTML or XML element.
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
display: function(display)
Hide or show the icon
{string} This property is used for CSS related to the drawing of the Control.
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
distanceTo: function(point)
{DOMElement}
{DOMElement} The element that contains the map
{DOMElement}
{DOMElement}
Returns OpenLayers.Handler.Drag
{Boolean}
draw: function (px)
draw: function(px)
Move the div to the given pixel.
draw: function(px)
Calls draw on the icon, and returns that output.
draw: function(px,
sz)
draw: function(px)
draw:function()
Clear out existing tile, and return whether to draw or not.
draw:function()
Check that a tile should be drawn, and draw it.
draw:function()
Check that a tile should be drawn, and load features for it.
drawFeature: function()
Private.
drawFeature: function()
Render features on the temporary layer.
{Boolean} A point is being drawn
drawMarker: function(marker)
Private.
{Boolean} internal state of drawing.
{Boolean} false
+ + + +
element: function(event)
Cross browser event element detection.
{DOMElement} the DOM element receiving browser events
equals:function(bounds)
Test a two bounds for equivalence
equals: function(geometry)
Tests for equivalent geometries
equals:function(geom)
equals:function(px)
Determine whether one pixel is equivalent to another
equals:function(sz)
Determine where this size is equal 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
{Function} bound event handler attached to elements
Private.
{OpenLayers.Events}
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{OpenLayers.Events}
Construct an OpenLayers.Events object.
{Array} list of support application events
{OpenLayers.Bounds} The image bounds in map units
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General3.html b/index/General3.html index b344c7a3b1..2e2ccec0f0 100644 --- a/index/General3.html +++ b/index/General3.html @@ -1,29 +1,33 @@ - - -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
O
 offset, OpenLayers.Icon
 onclick, OpenLayers. Popup
 ondblclick, OpenLayers. Popup
 onmousedown, OpenLayers. Popup
 onmousemove, OpenLayers. Popup
 onmouseout, OpenLayers. Popup
 onmouseup, OpenLayers. Popup
 onScreen
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Marker.Box
 opacity, OpenLayers. Popup
 OpenLayers
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Feature
 OpenLayers. Feature. Vector
 OpenLayers. Feature.WFS
 OpenLayers. Format
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 OpenLayers.Icon
 OpenLayers. Layer
 OpenLayers. Layer. Image
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Marker.Box
 OpenLayers. Pixel
 OpenLayers. Popup
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
 OpenLayers/ Control.js
 oppositeQuadrant, OpenLayers. Bounds
P
 padding, OpenLayers. Popup
 Pixel, OpenLayers. Pixel. OpenLayers
 Point, OpenLayers. Geometry. Point. OpenLayers. Geometry
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 popup, OpenLayers. Feature
 Popup, OpenLayers. Popup. OpenLayers
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 processXMLNode, OpenLayers. Feature.WFS
 projection
OpenLayers. LayerOpenLayers.Map
 Properties
GlobalOpenLayersOpenLayers. BoundsOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. GeometryOpenLayers. Geometry. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. ImageOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PixelOpenLayers. PopupOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 Properties and Functions, OpenLayers.Map
 px, OpenLayers.Icon
R
 read, OpenLayers. Format
 registerEvents, OpenLayers. Popup
 reproject, OpenLayers. Layer.WMS
 requestSuccess, OpenLayers. Tile.WFS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 setBackgroundColor, OpenLayers. Popup
 setBorder
OpenLayers. Marker.BoxOpenLayers. Popup
 setContentHTML, OpenLayers. Popup
 setOpacity
OpenLayers.IconOpenLayers. MarkerOpenLayers. Popup
 setOptions, OpenLayers.Map
 setSize
OpenLayers.IconOpenLayers. Popup
 show, OpenLayers. Popup
 size
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.MapOpenLayers. PopupOpenLayers.Tile
 Size, OpenLayers. Size. OpenLayers
 state, OpenLayers. Feature. Vector
 style
OpenLayers. Feature. VectorOpenLayers. Feature. Vector. OpenLayers. Feature. Vector
- -
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
onclick: function (evt)
Ignore clicks, but allowing default browser handling
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
{float}
The OpenLayers object provides a namespace for all things OpenLayers
Instances of this class represent bounding boxes.
Contains functions to create OpenLayers style classes.
The OpenLayers.Console namespace is used for debugging and error logging.
Features are combinations of geography and attributes.
Vector features use the OpenLayers.Geometry classes as geometry description.
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
Base class for format reading/writing a variety of formats.
A Geometry is a description of a geographic object.
A Collection is exactly what it sounds like: A collection of different Geometries.
A MultiLineString is a collection of LineStrings.
MultiPoint is a collection of Points.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
Instances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer.
Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services.
This class represents a longitude and latitude pair
Instances of OpenLayers.Map are interactive maps embedded in a web page.
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
This class represents a screen coordinate, in x and y coordinates
Instances of this class represent a width/height pair
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
OpenLayers.Bounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
- - - -
{int}
Create a new OpenLayers.Pixel instance
Construct a point geometry.
Constructor for a Polygon geometry.
{OpenLayers.Popup}
Create a popup.
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.
{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.
{OpenLayers.Pixel}
- - - -
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
registerEvents:function()
Registers events on the popup.
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
requestSuccess:function(request)
Called on return from request succcess.
{Array}
{Number}
- - - -
{Array}
setBackgroundColor:function(color)
setBorder: function (color,
width)
Allow the user to change the box’s color and border width
setBorder:function(border)
setContentHTML:function(contentHTML)
setOpacity: function(opacity)
Change the icon’s opacity
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOpacity:function(opacity)
setOptions: function(options)
Change the map options
setSize: function(size)
setSize:function(size)
show: function()
{OpenLayers.Size}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size}
{OpenLayers.Size} null
Create an instance of OpenLayers.Size
{String}
{Object}
OpenLayers features can have a number of style attributes.
- -
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
F
 fallThrough
OpenLayers. EventsOpenLayers.Map
 feature, OpenLayers. Handler. Feature
 Feature
OpenLayers. Feature. OpenLayersOpenLayers. Handler. Feature. OpenLayers. Handler
 features
OpenLayers. Layer. GeoRSSOpenLayers. Tile.WFS
 fid, OpenLayers. Feature. Vector
 finalize, OpenLayers. Handler. Point
 findElement, OpenLayers. Event
 Format, OpenLayers. Format. OpenLayers
 frame, OpenLayers. Tile. Image
 freehand, OpenLayers. Handler.Path
 freehandMode, OpenLayers. Handler.Path
 freehandToggle, OpenLayers. Handler.Path
 Functions
OpenLayersOpenLayers. BoundsOpenLayers. ClassOpenLayers. ConsoleOpenLayers. ControlOpenLayers. Control. ArgParserOpenLayers. Control. ZoomToMaxExtentOpenLayers. EventOpenLayers. EventsOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. Feature.WFSOpenLayers. FormatOpenLayers. Format.WKTOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. LineStringOpenLayers. Geometry. MultiLineStringOpenLayers. Geometry. MultiPointOpenLayers. Geometry. MultiPolygonOpenLayers. Geometry. PointOpenLayers. Geometry. PolygonOpenLayers. HandlerOpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers. Handler.PathOpenLayers. Handler. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. GeoRSSOpenLayers. Layer. ImageOpenLayers. Layer. MarkersOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. LonLatOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PixelOpenLayers. PopupOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
G
 geometry, OpenLayers. Feature. Vector
 Geometry, OpenLayers. Geometry. OpenLayers
 geometryClone
OpenLayers. Handler.PathOpenLayers. Handler. Point
 GeoRSS, OpenLayers. Layer. GeoRSS. OpenLayers. Layer
 getArea
OpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. Polygon
 getBoundsFromBaseLayer, OpenLayers.Tile
 getComponentsString, OpenLayers. Geometry. Collection
 getLayer, OpenLayers.Map
 getLayerIndex, OpenLayers.Map
 getLength
OpenLayers. GeometryOpenLayers. Geometry. Collection
 getMousePosition, OpenLayers. Events
 getNumLayers, OpenLayers.Map
 getTileSize, OpenLayers.Map
 getURL, OpenLayers. Layer.WMS
 group, OpenLayers. Console
 groupDiv, OpenLayers. Popup
 groupEnd, OpenLayers. Console
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
 handleBrowserEvent, OpenLayers. Events
 handleKeyEvent, OpenLayers. handler. Keyboard
 handler, OpenLayers. Control
 Handler, OpenLayers. Handler. OpenLayers
 hide, OpenLayers. Popup
I
 icon
OpenLayers. Layer. GeoRSSOpenLayers. Marker
 Icon, OpenLayers. Icon. OpenLayers
 id
OpenLayers. ControlOpenLayers. FeatureOpenLayers. GeometryOpenLayers. HandlerOpenLayers.MapOpenLayers.Tile
 Image
OpenLayers. Layer. Image. OpenLayers. LayerOpenLayers. Tile. Image. OpenLayers.Tile
 imageDiv, OpenLayers.Icon
 imgDiv, OpenLayers. Tile. Image
 inflate, OpenLayers. Marker
 info, OpenLayers. Console
 inherit, OpenLayers. Class
 initImgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. MarkersOpenLayers. Layer. Vector
 isLeftClick, OpenLayers. Event
K
 KEY_BACKSPACE, OpenLayers. Event
 KEY_DELETE, OpenLayers. Event
 KEY_DOWN, OpenLayers. Event
 KEY_ESC, OpenLayers. Event
 KEY_EVENTS, OpenLayers. handler. Keyboard
 KEY_LEFT, OpenLayers. Event
 KEY_RETURN, OpenLayers. Event
 KEY_RIGHT, OpenLayers. Event
 KEY_TAB, OpenLayers. Event
 KEY_UP, OpenLayers. Event
 Keyboard, OpenLayers. handler. Keyboard. OpenLayers. Handler
 keyMask, OpenLayers. Handler
+ +
{Boolean}
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
{OpenLayers.Feature.Vector}
Constructor for features.
Array({OpenLayers.Feature})
{Array(OpenLayers.Feature)} list of features in this tile
{String}
finalize: function()
Finish the geometry and call the “done” callback.
findElement: function(event,
tagName)
Instances of this class are not useful.
{DOMElement} The image element is appended to the frame.
{Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up.
freehandMode: function(evt)
Private.
{String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand.
+ + + +
{OpenLayers.Geometry}
Creates a geometry object.
geometryClone: function()
Private.
geometryClone: function()
Return a clone of the relevant geometry.
Create a GeoRSS Layer.
getArea: function()
Calculate the area of this geometry.
getArea: function()
Calculate the area of this geometry.
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.
getComponentsString: function()
Get a string representing the components for this collection
getLayer: function(id)
Get a layer based on its id
getLayerIndex: function (layer)
@param {OpenLayers.Layer} layer
getLength: function()
Calculate the length of this geometry.
getLength: function()
Calculate the length of this geometry
getMousePosition: function (evt)
Private
getNumLayers: function ()
Return: {Int} The number of layers attached to the map.
getTileSize: function()
Get the tile size for the map
getURL: function (bounds)
Return a GetMap query string for this layer
group: function()
Writes a message to the console and opens a nested block to indent all future messages sent to the console.
{DOMElement}
groupEnd: function()
Closes the most recently opened block created by a call to OpenLayers.Console.group
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
+ + + +
{Number} height
handleBrowserEvent: function (evt)
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
handleKeyEvent: function (evt)
{OpenLayers.Handler} null
Construct a handler.
hide: function()
+ + + +
{OpenLayers.Icon}
{OpenLayers.Icon}
Creates an icon, which is an image tag in a div.
{String}
{String}
{String} A unique identifier for this geometry.
Private.
{String} Unique identifier for the map
{String} null
Create a new image layer
Constructor for a new OpenLayers.Tile.Image instance.
{DOMElement}
{DOMElement} The div element which wraps the image.
inflate: function(inflate)
info: function()
Writes a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
inherit: function ()
Inherit from one or more OpenLayers style classes
initImgDiv: function()
Creates the imgDiv property on the tile.
{Boolean} The layer is a base layer.
{Boolean} Markers layer is never a base layer.
{Boolean} The layer is a base layer.
isLeftClick: function(event)
Determine whether event was caused by a left click.
+ + + +
{int}
{int}
{int}
{int}
keydown, keypress, keyup
{int}
{int}
{int}
{int}
{int}
{Number}
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General4.html b/index/General4.html index 07f488fbff..88f57b360b 100644 --- a/index/General4.html +++ b/index/General4.html @@ -1,41 +1,25 @@ - - -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
 toggle, OpenLayers. Popup
 top, OpenLayers. Bounds
 toShortString, OpenLayers. Geometry. Point
 toState, OpenLayers. Feature. Vector
 toString
OpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
U
 units
OpenLayers. LayerOpenLayers.Map
 unloadDestroy, OpenLayers.Map
 updatePosition, OpenLayers. Popup
 url
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 Vector
OpenLayers. Feature. Vector. OpenLayers. FeatureOpenLayers. Layer. Vector. OpenLayers. Layer
 VERSION_NUMBER, OpenLayers
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
 visible, OpenLayers. Popup
W
 w, OpenLayers.Size
 warn, OpenLayers. Console
 WFS
OpenLayers. Feature. WFS. OpenLayers. FeatureOpenLayers. Tile. WFS. OpenLayers.Tile
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 wrapDateLine, OpenLayers. Layer
 write, OpenLayers. Format
X
 x
OpenLayers. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
Z
 Z_INDEX_BASE, OpenLayers.Map
 zoom, OpenLayers.Map
- -
{String} Relative path to a CSS file from which to load theme styles.
{OpenLayers.Tile.Image}
Constructor for a new OpenLayers.Tile instance.
{Integer} 256
{Integer} 256
{OpenLayers.Size} Set in the map options to override the default tile size for this map.
time: function()
Creates a new timer under the given name.
toggle: function()
{Number}
toShortString: function()
{String} Shortened String representation of Point object.
toState: function(state)
Sets the new state
toString:function()
Return a readable string version of the lonlat
toString:function()
Cast this object into a string
toString:function()
Return the string representation of a size object
trace: function()
Prints an interactive stack trace of JavaScript execution at the point where it is called.
- - - -
{String} The layer map units.
{String} The map units.
Function that is called to destroy the map on page unload.
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
{String} image url
{String} URL of the image to use
{String} url of the request
{String} The URL of the image being requested.
{String}
- - - -
Create a vector feature.
Create a new vector layer
{HTMLDivElement} The element that represents the map viewport
{String} Used to store a unique identifier that changes when the map view changes.
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
- - - -
{Number} width
warn: function()
Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
Create a WFS feature.
Constructor for a new OpenLayers.Tile.WFS instance.
Create a new WMS layer object
{Boolean} #487 for more info.
write: function(object)
Accept an object, and return a string.
- - - -
{float}
{Number} The x coordinate
- - - -
{float}
- - - -
{Object} Base z-indexes for different classes of thing
{Integer} The current zoom level of the map
- -
Generated by Natural Docs
+ + + + + + +
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
L
 lastDown, OpenLayers. Handler. Point
 lastUp, OpenLayers. Handler. Point
 layer
OpenLayers. FeatureOpenLayers. Handler. PointOpenLayers.Tile
 Layer, OpenLayers. Layer. OpenLayers
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layerIndex, OpenLayers. Handler. Feature
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 line, OpenLayers. Handler.Path
 LineString, OpenLayers. Geometry. LineString. OpenLayers. Geometry
 listeners, OpenLayers. Events
 loadFeaturesForRegion, OpenLayers. Tile.WFS
 location, OpenLayers. Layer. GeoRSS
 log, OpenLayers. Console
 lonlat
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Popup
 LonLat, OpenLayers. LonLat. OpenLayers
M
 map
OpenLayers. ControlOpenLayers. HandlerOpenLayers. MarkerOpenLayers. Popup
 Map, OpenLayers. Map. OpenLayers
 marker, OpenLayers. Feature
 Marker, OpenLayers. Marker. OpenLayers
 markerClick, OpenLayers. Layer. GeoRSS
 markers, OpenLayers. Layer. Markers
 Markers, OpenLayers. Layer. Markers. OpenLayers. Layer
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
 modifyFeature, OpenLayers. Handler.Path
 mousedown
OpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. Handler.PathOpenLayers. Handler. Point
 mouseDown, OpenLayers. Handler. Point
 mousemove
OpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. Handler. MouseWheelOpenLayers. Handler.PathOpenLayers. Handler. Point
 mouseout, OpenLayers. Handler.Drag
 mousePosition, OpenLayers. Handler. MouseWheel
 mouseup
OpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. Handler.PathOpenLayers. Handler. Point
 MouseWheel, OpenLayers. Handler. MouseWheel. OpenLayers. Handler
 move
OpenLayers. Geometry. CollectionOpenLayers. Geometry. Point
 moveTo
OpenLayers. ControlOpenLayers.IconOpenLayers. Layer. MarkersOpenLayers. MarkerOpenLayers. PopupOpenLayers.TileOpenLayers. Tile. Image
 MultiLineString, OpenLayers. Geometry. MultiLineString. OpenLayers. Geometry
 MultiPoint, OpenLayers. Geometry. MultiPoint. OpenLayers. Geometry
 MultiPolygon, OpenLayers. Geometry. MultiPolygon. OpenLayers. Geometry
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
+ +
{OpenLayers.Pixel} Location of the last mouse down
{OpenLayers.Pixel}
{OpenLayers.Layer}
{OpenLayers.Layer.Vector} The temporary drawing 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)
{Int}
{Array(OpenLayers.Layer)} Ordered list of layers in the map
{Number}
Private.
Create a new LineString geometry
{Object} Hashtable of Array(Function): events listener functions
loadFeaturesForRegion:function(success,
failure)
get the full request string from the ds and the tile params and call the AJAX loadURL().
{String} store url of text file
log: function()
Log an object in the console.
{OpenLayers.LonLat}
{OpenLayers.LonLat} location of object
{OpenLayers.LonLat}
Create a new OpenLayers.LonLat instance
+ + + +
{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map
Private.
{OpenLayers.Map}
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
Constructor for a new OpenLayers.Map instance.
{OpenLayers.Marker}
markerClick: function(evt)
Array({OpenLayers.Marker}) internal marker list
Create a Markers layer.
{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}
modifyFeature: function()
Private.
mousedown: function (evt)
Handle mousedown events
mousedown: function(evt)
Handle mouse down.
mousedown: function(evt)
Private.
mousedown: function(evt)
Handle mouse down.
{Boolean} The mouse is down
mousemove: function (evt)
Handle mousemove events
mousemove: function(evt)
Handle mouse moves.
mousemove: function (evt)
Update the stored mousePosition on every move.
mousemove: function (evt)
Private.
mousemove: function (evt)
Handle mouse move.
mouseout: function (evt)
Handle mouseout events
Private.
mouseup: function (evt)
Handle mouseup events
mouseup: function(evt)
Handle mouse up.
mouseup: function (evt)
Private.
mouseup: function (evt)
Handle mouse up.
move: function(x,
y)
Moves a collection in place
move: function(x,
y)
Moves a point in place
moveTo: function (px)
moveTo: function (px)
move icon to passed in px.
moveTo:function(bounds,
zoomChanged,
dragging)
moveTo: function (px)
Move the marker to the new location.
moveTo: function(px)
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
moveTo: function (bounds,
position,
redraw)
Reposition the tile.
Constructor for a MultiLineString Geometry.
Create a new MultiPoint Geometry
Create a new MultiPolygon geometry
+ + + +
{Integer}
{Integer} Number of zoom levels for the map.
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General5.html b/index/General5.html new file mode 100644 index 0000000000..627ec31af2 --- /dev/null +++ b/index/General5.html @@ -0,0 +1,25 @@ + + +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
O
 object, OpenLayers. Events
 observe, OpenLayers. Event
 observers, OpenLayers. Event
 offset, OpenLayers.Icon
 oldOnselectstart, OpenLayers. Handler.Drag
 onclick, OpenLayers. Popup
 ondblclick, OpenLayers. Popup
 onmousedown, OpenLayers. Popup
 onmousemove, OpenLayers. Popup
 onmouseout, OpenLayers. Popup
 onmouseup, OpenLayers. Popup
 onScreen
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Marker.Box
 onWheelEvent, OpenLayers. Handler. MouseWheel
 opacity, OpenLayers. Popup
 OpenLayers
 OpenLayers Base Types
 OpenLayers. Bounds
 OpenLayers. Class
 OpenLayers. Console
 OpenLayers. Control
 OpenLayers. Control. ArgParser
 OpenLayers. Control. ZoomToMaxExtent
 OpenLayers. Event
 OpenLayers. Feature
 OpenLayers. Feature. Vector
 OpenLayers. Feature.WFS
 OpenLayers. Format
 OpenLayers. Format.WKT
 OpenLayers. Geometry
 OpenLayers. Geometry. Collection
 OpenLayers. Geometry. LineString
 OpenLayers. Geometry. MultiLineString
 OpenLayers. Geometry. MultiPoint
 OpenLayers. Geometry. MultiPolygon
 OpenLayers. Geometry. Point
 OpenLayers. Geometry. Polygon
 OpenLayers. Handler
 OpenLayers. Handler.Drag
 OpenLayers. Handler. Feature
 OpenLayers. handler. Keyboard
 OpenLayers. Handler. MouseWheel
 OpenLayers. Handler.Path
 OpenLayers. Handler. Point
 OpenLayers.Icon
 OpenLayers. Layer
 OpenLayers. Layer. GeoRSS
 OpenLayers. Layer. Image
 OpenLayers. Layer. Markers
 OpenLayers. Layer. Vector
 OpenLayers. Layer.WMS
 OpenLayers. LonLat
 OpenLayers.Map
 OpenLayers. Marker
 OpenLayers. Marker.Box
 OpenLayers. Pixel
 OpenLayers. Popup
 OpenLayers.Size
 OpenLayers.Tile
 OpenLayers. Tile. Image
 OpenLayers. Tile.WFS
 oppositeQuadrant, OpenLayers. Bounds
P
 padding, OpenLayers. Popup
 parent, OpenLayers. Geometry
 parseData, OpenLayers. Layer. GeoRSS
 Path, OpenLayers. Handler. Path. OpenLayers. Handler
 Pixel, OpenLayers. Pixel. OpenLayers
 point, OpenLayers. Handler. Point
 Point
OpenLayers. Geometry. Point. OpenLayers. GeometryOpenLayers. Handler. Point. OpenLayers. Handler
 Polygon, OpenLayers. Geometry. Polygon. OpenLayers. Geometry
 popup, OpenLayers. Feature
 Popup, OpenLayers. Popup. OpenLayers
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 processXMLNode, OpenLayers. Feature.WFS
 projection
OpenLayers. LayerOpenLayers.Map
 Properties
OpenLayersOpenLayers. BoundsOpenLayers. ControlOpenLayers. Control. ZoomToMaxExtentOpenLayers. EventOpenLayers. EventsOpenLayers. FeatureOpenLayers. Feature. VectorOpenLayers. GeometryOpenLayers. Geometry. CollectionOpenLayers. Geometry. PointOpenLayers. HandlerOpenLayers. Handler.DragOpenLayers. Handler. FeatureOpenLayers. handler. KeyboardOpenLayers. Handler. MouseWheelOpenLayers. Handler.PathOpenLayers. Handler. PointOpenLayers.IconOpenLayers. LayerOpenLayers. Layer. GeoRSSOpenLayers. Layer. ImageOpenLayers. Layer. MarkersOpenLayers. Layer. VectorOpenLayers. Layer.WMSOpenLayers. MarkerOpenLayers. Marker.BoxOpenLayers. PixelOpenLayers. PopupOpenLayers.SizeOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
 Properties and Functions, OpenLayers.Map
 px, OpenLayers.Icon
R
 raiseLayer, OpenLayers.Map
 read
OpenLayers. FormatOpenLayers. Format.WKT
 redraw, OpenLayers. Layer. Markers
 register
OpenLayers. EventsOpenLayers. Handler
 registerEvents, OpenLayers. Popup
 registerPriority, OpenLayers. Events
 remove, OpenLayers. Events
 removeComponent
OpenLayers. Geometry. CollectionOpenLayers. Geometry. LineString
 removeComponents, OpenLayers. Geometry. Collection
 removeLayer, OpenLayers.Map
 removeMarker, OpenLayers. Layer. Markers
 reproject, OpenLayers. Layer.WMS
 requestSuccess, OpenLayers. Tile.WFS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
+ +
{Object} the code object issuing application events
observe: function(elementParam,
name,
observer,
useCapture)
{Object} A hashtable cache of the event observers.
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
Private.
onclick: function (evt)
Ignore clicks, but allowing default browser handling
ondblclick: function (evt)
Ignore double-clicks, but allowing default browser handling
onmousedown: function (evt)
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousemove: function (evt)
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseout: function (evt)
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseup: function (evt)
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onScreen:function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
onScreen:function()
{Boolean} Whether or not the marker is currently visible on screen.
onWheelEvent: function(e)
Catch the wheel event and handle it xbrowserly
{float}
The OpenLayers object provides a namespace for all things OpenLayers
Basic types in OpenLayers are described here.
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.
Controls affect the display or behavior of the map.
Imlements a very simple button control.
Utility functions for event handling.
Features are combinations of geography and attributes.
Vector features use the OpenLayers.Geometry classes as geometry description.
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
Base class for format reading/writing a variety of formats.
Class for reading and writing Well-Known Text.
A Geometry is a description of a geographic object.
A Collection is exactly what it sounds like: A collection of different Geometries.
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
A MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components.
MultiPoint is a collection of Points.
MultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components.
Point geometry class.
Polygon is a collection of Geometry.LinearRings.
Base class to construct a higher-level handler for event sequences.
Handler to respond to mouse events related to a drawn feature.
Handler for wheel up/down events.
Handler to draw a path on the map.
Handler to draw a point on the map.
Add GeoRSS Point features to your map.
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.
+ + + +
{int}
{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry
parseData: function(ajaxRequest)
Parse the data returned from the Events call.
Create a new path hander
Create a new OpenLayers.Pixel instance
{OpenLayers.Feature.Vector} The currently drawn point
Construct a point geometry.
Create a new point handler.
Constructor for a Polygon geometry.
{OpenLayers.Popup}
Create a popup.
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
processXMLNode: function(xmlNode)
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.
{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.
{OpenLayers.Pixel}
+ + + +
raiseLayer: function (layer,
delta)
Change the index of the given layer by delta.
read: function(data)
Read data from a string, and return an object whose type depends on the subclass.
read: function(wkt)
Deserialize a WKT string and return an OpenLayers.Feature.Vector or an array of OpenLayers.Feature.Vector.
redraw: function()
clear all the marker div’s from the layer and then redraw all of them.
register: function (type,
obj,
func)
Register an event on the events object.
register: function (name,
method)
register an event on the map
registerEvents:function()
Registers events on the popup.
registerPriority: function (type,
obj,
func)
remove: function(type)
Remove all listeners for a given event type.
removeComponent: function(component)
Remove a component from this geometry.
removeComponent: function(point)
Only allows removal of a point if there are three or more points in the linestring.
removeComponents: function(components)
Remove components from this geometry.
removeLayer: function(layer,
setNewBaseLayer)
Removes a layer from the map by removing its visual element (the layer.div property), then removing it from the map’s internal list of layers, setting the layer’s map property to null.
removeMarker: function(marker)
{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}
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/General6.html b/index/General6.html new file mode 100644 index 0000000000..ba755fb9d7 --- /dev/null +++ b/index/General6.html @@ -0,0 +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
S
 scales, OpenLayers. Layer
 select, OpenLayers. Handler. Feature
 selectedFeature, OpenLayers. Layer. GeoRSS
 setBackgroundColor, OpenLayers. Popup
 setBorder
OpenLayers. Marker.BoxOpenLayers. Popup
 setCenter, OpenLayers. Control. ArgParser
 setContentHTML, OpenLayers. Popup
 setLayerIndex, OpenLayers.Map
 setLayerZIndex, OpenLayers.Map
 setMap
OpenLayers. ControlOpenLayers. Control. ArgParserOpenLayers. Handler
 setOpacity
OpenLayers.IconOpenLayers. MarkerOpenLayers. Popup
 setOptions, OpenLayers.Map
 setSize
OpenLayers.IconOpenLayers. Popup
 show, OpenLayers. Popup
 size
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.MapOpenLayers. PopupOpenLayers.Tile
 Size, OpenLayers. Size. OpenLayers
 start, OpenLayers. Handler.Drag
 started, OpenLayers. Handler.Drag
 state, OpenLayers. Feature. Vector
 stop, OpenLayers. Event
 stopObserving, OpenLayers. Event
 stopObservingElement, OpenLayers. Event
 style
OpenLayers. Feature. VectorOpenLayers. Feature. Vector. OpenLayers. Feature. Vector
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 Tile, OpenLayers. Tile. OpenLayers
 TILE_HEIGHT, OpenLayers.Map
 TILE_WIDTH, OpenLayers.Map
 tileSize, OpenLayers.Map
 time, OpenLayers. Console
 toggle, OpenLayers. Popup
 top, OpenLayers. Bounds
 toShortString, OpenLayers. Geometry. Point
 toState, OpenLayers. Feature. Vector
 toString
OpenLayers. GeometryOpenLayers. LonLatOpenLayers. PixelOpenLayers.Size
 trace, OpenLayers. Console
 trigger, OpenLayers. Control. ZoomToMaxExtent
 triggerEvent, OpenLayers. Events
 type
OpenLayers. ControlOpenLayers. Control. ZoomToMaxExtent
U
 units
OpenLayers. LayerOpenLayers.Map
 unloadCache, OpenLayers. Event
 unloadDestroy, OpenLayers.Map
 unregister
OpenLayers. EventsOpenLayers. Handler
 updatePosition, OpenLayers. Popup
 url
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 Vector
OpenLayers. Feature. Vector. OpenLayers. FeatureOpenLayers. Layer. Vector. OpenLayers. Layer
 VERSION_NUMBER, OpenLayers
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
 visible, OpenLayers. Popup
W
 w, OpenLayers.Size
 warn, OpenLayers. Console
 WFS
OpenLayers. Feature. WFS. OpenLayers. FeatureOpenLayers. Tile. WFS. OpenLayers.Tile
 wheelListener, OpenLayers. Handler. MouseWheel
 WKT, OpenLayers. Format. WKT. OpenLayers. Format
 WMS, OpenLayers. Layer. WMS. OpenLayers. Layer
 wrapDateLine, OpenLayers. Layer
 write
OpenLayers. FormatOpenLayers. Format.WKT
X
 x
OpenLayers. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
Z
 Z_INDEX_BASE, OpenLayers.Map
 zoom, OpenLayers.Map
+ +
{Array}
select: function(type,
evt)
Trigger the appropriate callback if a feature is under the mouse.
{OpenLayers.Feature}
setBackgroundColor:function(color)
setBorder: function (color,
width)
Allow the user to change the box’s color and border width
setBorder:function(border)
setCenter: function()
As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.
setContentHTML:function(contentHTML)
setLayerIndex: function (layer,
idx)
Move the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.
setLayerZIndex: function (layer,
zIdx)
Private.
setMap: function(map)
Set the map property for the control.
setMap: function(map)
Set the map property for the control.
setMap: function (map)
setOpacity: function(opacity)
Change the icon’s opacity
setOpacity: function(opacity)
Change the opacity of the marker by changin the opacity of its icon
setOpacity:function(opacity)
setOptions: function(options)
Change the map options
setSize: function(size)
setSize:function(size)
show: function()
{OpenLayers.Size}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size}
{OpenLayers.Size} null
Create an instance of OpenLayers.Size
{OpenLayers.Pixel}
{Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting.
{String}
stop: function(event,
allowDefault)
Stops an event from propagating.
stopObserving: function(elementParam,
name,
observer,
useCapture)
stopObservingElement: function(elementParam)
Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.
{Object}
OpenLayers features can have a number of style attributes.
+ + + +
{String} Relative path to a CSS file from which to load theme styles.
{OpenLayers.Tile.Image}
Constructor for a new OpenLayers.Tile instance.
{Integer} 256
{Integer} 256
{OpenLayers.Size} Set in the map options to override the default tile size for this map.
time: function()
Creates a new timer under the given name.
toggle: function()
{Number}
toShortString: function()
{String} Shortened String representation of Point object.
toState: function(state)
Sets the new state
toString: function()
Returns the Well-Known Text representation of a geometry
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.
trigger: function()
Do the zoom.
triggerEvent: function (type,
evt)
Trigger a specified registered event
{OpenLayers.Control.TYPES} Controls can have a ‘type’.
TYPE_BUTTON.
+ + + +
{String} The layer map units.
{String} The map units.
unloadCache: function()
Cycle through all the element entries in the events cache and call stopObservingElement on each.
Function that is called to destroy the map on page unload.
unregister: function (type,
obj,
func)
unregister: function (name,
method)
unregister an event from the map
updatePosition: function()
if the popup has a lonlat and its map members set, then have it move itself to its proper position
{String} image url
{String} URL of the image to use
{String} url of the request
{String} The URL of the image being requested.
{String}
+ + + +
Create a vector feature.
Create a new vector layer
{HTMLDivElement} The element that represents the map viewport
{String} Used to store a unique identifier that changes when the map view changes.
visible: function()
{Boolean} Boolean indicating whether or not the popup is visible
+ + + +
{Number} width
warn: function()
Writes a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
Create a WFS feature.
Constructor for a new OpenLayers.Tile.WFS instance.
{function}
Create a new parser for WKT
Create a new WMS layer object
{Boolean} #487 for more info.
write: function(object)
Accept an object, and return a string.
write: function(features)
Serialize a feature or array of features into a WKT 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 c65f3bde55..188ccf20ba 100644 --- a/index/Properties.html +++ b/index/Properties.html @@ -1,109 +1,81 @@ - - -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
 active
 aspectRatio, OpenLayers. Layer. Image
 attributes, OpenLayers. Feature. Vector
B
 backgroundColor, OpenLayers. Popup
 baseLayer, OpenLayers.Map
 border, OpenLayers. Popup
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers. Marker.BoxOpenLayers.Tile
C
 calculateOffset, OpenLayers.Icon
 center, OpenLayers.Map
 contentDiv, OpenLayers. Popup
 contentHTML, OpenLayers. Popup
 controls, OpenLayers.Map
D
 data, OpenLayers. Feature
 displayOutsideMaxExtent, OpenLayers. Layer
 div
OpenLayers.MapOpenLayers. Marker.BoxOpenLayers. Popup
 drawn, OpenLayers.Tile
E
 events
OpenLayers. FeatureOpenLayers.MapOpenLayers. MarkerOpenLayers. Popup
 extent, OpenLayers. Layer. Image
F
 fallThrough, OpenLayers.Map
 features, OpenLayers. Tile.WFS
 fid, OpenLayers. Feature. Vector
 frame, OpenLayers. Tile. Image
G
 geometry, OpenLayers. Feature. Vector
 groupDiv, OpenLayers. Popup
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
 handler
I
 icon, OpenLayers. Marker
 id
OpenLayers. FeatureOpenLayers.MapOpenLayers.Tile
 imageDiv, OpenLayers.Icon
 imgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. Vector
L
 layer
OpenLayers. FeatureOpenLayers.Tile
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 lonlat
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Popup
M
 map
OpenLayers. MarkerOpenLayers. Popup
 marker, OpenLayers. Feature
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
O
 offset, OpenLayers.Icon
 opacity, OpenLayers. Popup
P
 padding, OpenLayers. Popup
 popup, OpenLayers. Feature
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
 px, OpenLayers.Icon
R
 reproject, OpenLayers. Layer.WMS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
S
 scales, OpenLayers. Layer
 size
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.MapOpenLayers. PopupOpenLayers.Tile
 state, OpenLayers. Feature. Vector
 style, OpenLayers. Feature. Vector
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 tileSize, OpenLayers.Map
 top, OpenLayers. Bounds
U
 units
OpenLayers. LayerOpenLayers.Map
 url
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 wrapDateLine, OpenLayers. Layer
X
 x
OpenLayers. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
Z
 zoom, OpenLayers.Map
- -
{String} Relative path of this script.
- - - -
{boolean} null
{Number} The ratio of height/width represented by a single pixel in the graphic
{Object}
- - - -
{String}
{String}
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
- - - -
{OpenLayers.Pixel} Function to calculate the offset (based on the size)
{OpenLayers.LonLat} The current center of the map
{DOMElement}
{String}
{Array(OpenLayers.Control)} List of controls associated with the map
- - - -
{Object}
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
{DOMElement} The element that contains the map
{DOMElement}
{DOMElement}
{Boolean} false
- - - -
{OpenLayers.Events}
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{OpenLayers.Events}
{OpenLayers.Bounds} The image bounds in map units
- - - -
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
{Array(OpenLayers.Feature)} list of features in this tile
{String}
{DOMElement} The image element is appended to the frame.
- - - -
{OpenLayers.Geometry}
{DOMElement}
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
- - - -
{Number} height
{OpenLayers.Handler} null
- - - -
{OpenLayers.Icon}
{String}
{String} Unique identifier for the map
{String} null
{DOMElement}
{DOMElement} The div element which wraps the image.
{Boolean} The layer is a base layer.
{Boolean} The layer is a base layer.
- - - -
{OpenLayers.Layer}
{OpenLayers.Layer} layer the tile is attached to
{HTMLDivElement} The element that contains the layers.
{OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom)
{Array(OpenLayers.Layer)} Ordered list of layers in the map
{Number}
{OpenLayers.LonLat}
{OpenLayers.LonLat} location of object
{OpenLayers.LonLat}
- - - -
{OpenLayers.Map}
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
{OpenLayers.Marker}
{OpenLayers.Bounds}
{OpenLayers.Bounds} The maximum extent for the map.
{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
{Number} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
{Number}
{Number}
{OpenLayers.Bounds}
{OpenLayers.Bounds}
{Number}
{Number}
{Number}
- - - -
{Integer}
{Integer} Number of zoom levels for the map.
- - - -
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
{float}
- - - -
{int}
{OpenLayers.Popup}
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.
{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.
{OpenLayers.Pixel}
- - - -
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
{Array}
{Number}
- - - -
{Array}
{OpenLayers.Size}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size}
{OpenLayers.Size} null
{String}
{Object}
- - - -
{String} 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} image url
{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
+ + + + + + +
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
OpenLayers. ControlOpenLayers. Handler
 aspectRatio, OpenLayers. Layer. Image
 attributes, OpenLayers. Feature. Vector
B
 backgroundColor, OpenLayers. Popup
 baseLayer, OpenLayers.Map
 border, OpenLayers. Popup
 bottom, OpenLayers. Bounds
 bounds
OpenLayers. GeometryOpenLayers. Marker.BoxOpenLayers.Tile
C
 calculateOffset, OpenLayers.Icon
 center, OpenLayers.Map
 components, OpenLayers. Geometry. Collection
 contentDiv, OpenLayers. Popup
 contentHTML, OpenLayers. Popup
 control, OpenLayers. Handler
 controls, OpenLayers.Map
D
 data, OpenLayers. Feature
 displayClass, OpenLayers. Control
 displayOutsideMaxExtent, OpenLayers. Layer
 div
OpenLayers. ControlOpenLayers.MapOpenLayers. Marker.BoxOpenLayers. Popup
 dragging, OpenLayers. Handler.Drag
 drawing, OpenLayers. Handler. Point
 drawn
OpenLayers. Layer. MarkersOpenLayers.Tile
E
 element, OpenLayers. Events
 eventHandler, OpenLayers. Events
 eventListener, OpenLayers. handler. Keyboard
 events
OpenLayers. FeatureOpenLayers.MapOpenLayers. MarkerOpenLayers. Popup
 eventTypes, OpenLayers. Events
 extent, OpenLayers. Layer. Image
F
 fallThrough
OpenLayers. EventsOpenLayers.Map
 feature, OpenLayers. Handler. Feature
 features
OpenLayers. Layer. GeoRSSOpenLayers. Tile.WFS
 fid, OpenLayers. Feature. Vector
 frame, OpenLayers. Tile. Image
 freehand, OpenLayers. Handler.Path
 freehandToggle, OpenLayers. Handler.Path
G
 geometry, OpenLayers. Feature. Vector
 groupDiv, OpenLayers. Popup
 gutter, OpenLayers. Layer
H
 h, OpenLayers.Size
 handler, OpenLayers. Control
I
 icon
OpenLayers. Layer. GeoRSSOpenLayers. Marker
 id
OpenLayers. ControlOpenLayers. FeatureOpenLayers. GeometryOpenLayers. HandlerOpenLayers.MapOpenLayers.Tile
 imageDiv, OpenLayers.Icon
 imgDiv, OpenLayers. Tile. Image
 isBaseLayer
OpenLayers. Layer. ImageOpenLayers. Layer. MarkersOpenLayers. Layer. Vector
K
 keyMask, OpenLayers. Handler
L
 lastDown, OpenLayers. Handler. Point
 lastUp, OpenLayers. Handler. Point
 layer
OpenLayers. FeatureOpenLayers. Handler. PointOpenLayers.Tile
 layerContainerDiv, OpenLayers.Map
 layerContainerOrigin, OpenLayers.Map
 layerIndex, OpenLayers. Handler. Feature
 layers, OpenLayers.Map
 left, OpenLayers. Bounds
 line, OpenLayers. Handler.Path
 listeners, OpenLayers. Events
 location, OpenLayers. Layer. GeoRSS
 lonlat
OpenLayers. FeatureOpenLayers. MarkerOpenLayers. Popup
M
 map
OpenLayers. ControlOpenLayers. HandlerOpenLayers. MarkerOpenLayers. Popup
 marker, OpenLayers. Feature
 markers, OpenLayers. Layer. Markers
 maxExtent
OpenLayers. LayerOpenLayers.Map
 maxResolution
OpenLayers. LayerOpenLayers.Map
 maxScale
OpenLayers. LayerOpenLayers.Map
 minExtent
OpenLayers. LayerOpenLayers.Map
 minResolution
OpenLayers. LayerOpenLayers.Map
 minScale
OpenLayers. LayerOpenLayers.Map
 mouseDown, OpenLayers. Handler. Point
 mousePosition, OpenLayers. Handler. MouseWheel
N
 numZoomLevels
OpenLayers. LayerOpenLayers.Map
O
 object, OpenLayers. Events
 observers, OpenLayers. Event
 offset, OpenLayers.Icon
 oldOnselectstart, OpenLayers. Handler.Drag
 opacity, OpenLayers. Popup
P
 padding, OpenLayers. Popup
 parent, OpenLayers. Geometry
 point, OpenLayers. Handler. Point
 popup, OpenLayers. Feature
 popups, OpenLayers.Map
 position, OpenLayers.Tile
 projection
OpenLayers. LayerOpenLayers.Map
 px, OpenLayers.Icon
R
 reproject, OpenLayers. Layer.WMS
 resolutions, OpenLayers. Layer
 right, OpenLayers. Bounds
+ +
{String} Relative path of this script.
+ + + +
{boolean} null
Private.
{Number} The ratio of height/width represented by a single pixel in the graphic
{Object}
+ + + +
{String}
{String}
{Number}
{OpenLayers.Bounds} The bounds of this geometry
{OpenLayers.Bounds}
{OpenLayers.Bounds} null
+ + + +
{OpenLayers.Pixel} Function to calculate the offset (based on the size)
{OpenLayers.LonLat} The current center of the map
{Array(OpenLayers.Geometry)} The component parts of this geometry
{DOMElement}
{String}
Private.
{Array(OpenLayers.Control)} List of controls associated with the map
+ + + +
{Object}
{string} This property is used for CSS related to the drawing of the Control.
{Boolean} Request map tiles that are completely outside of the max extent for this layer.
{DOMElement}
{DOMElement} The element that contains the map
{DOMElement}
{DOMElement}
{Boolean}
{Boolean} A point is being drawn
{Boolean} internal state of drawing.
{Boolean} false
+ + + +
{DOMElement} the DOM element receiving browser events
{Function} bound event handler attached to elements
Private.
{OpenLayers.Events}
{OpenLayers.Events} An events object that handles all events on the map
{OpenLayers.Events}
{OpenLayers.Events}
{Array} list of support application events
{OpenLayers.Bounds} The image bounds in map units
+ + + +
{Boolean}
{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
{OpenLayers.Feature.Vector}
Array({OpenLayers.Feature})
{Array(OpenLayers.Feature)} list of features in this tile
{String}
{DOMElement} The image element is appended to the frame.
{Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up.
{String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand.
+ + + +
{OpenLayers.Geometry}
{DOMElement}
{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
+ + + +
{Number} height
{OpenLayers.Handler} null
+ + + +
{OpenLayers.Icon}
{OpenLayers.Icon}
{String}
{String}
{String} A unique identifier for this geometry.
Private.
{String} Unique identifier for the map
{String} null
{DOMElement}
{DOMElement} The div element which wraps the image.
{Boolean} The layer is a base layer.
{Boolean} Markers layer is never a base layer.
{Boolean} The layer is a base layer.
+ + + +
{Number}
+ + + +
{OpenLayers.Pixel} Location of the last mouse down
{OpenLayers.Pixel}
{OpenLayers.Layer}
{OpenLayers.Layer.Vector} The temporary drawing 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)
{Int}
{Array(OpenLayers.Layer)} Ordered list of layers in the map
{Number}
Private.
{Object} Hashtable of Array(Function): events listener functions
{String} store url of text file
{OpenLayers.LonLat}
{OpenLayers.LonLat} location of object
{OpenLayers.LonLat}
+ + + +
{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map
Private.
{OpenLayers.Map}
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
{OpenLayers.Marker}
Array({OpenLayers.Marker}) internal marker list
{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}
{Boolean} The mouse is down
Private.
+ + + +
{Integer}
{Integer} Number of zoom levels for the map.
+ + + +
{Object} the code object issuing application events
{Object} A hashtable cache of the event observers.
{OpenLayers.Pixel} distance in pixels to offset the image when being rendered
Private.
{float}
+ + + +
{int}
{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry
{OpenLayers.Feature.Vector} The currently drawn point
{OpenLayers.Popup}
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.Pixel} Top Left pixel of the tile
{String} Set in the layer options to override the default projection string this layer - also set maxExtent, maxResolution, and units if appropriate.
{String} Set in the map options to override the default projection string this map - also set maxExtent, maxResolution, and units if appropriate.
{OpenLayers.Pixel}
+ + + +
{Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.
{Array}
{Number}
+ +
Generated by Natural Docs
\ No newline at end of file diff --git a/index/Properties2.html b/index/Properties2.html new file mode 100644 index 0000000000..bd7a779078 --- /dev/null +++ b/index/Properties2.html @@ -0,0 +1,45 @@ + + +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
S
 scales, OpenLayers. Layer
 selectedFeature, OpenLayers. Layer. GeoRSS
 size
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.MapOpenLayers. PopupOpenLayers.Tile
 start, OpenLayers. Handler.Drag
 started, OpenLayers. Handler.Drag
 state, OpenLayers. Feature. Vector
 style, OpenLayers. Feature. Vector
T
 theme, OpenLayers.Map
 tile, OpenLayers. Layer. Image
 tileSize, OpenLayers.Map
 top, OpenLayers. Bounds
 type
OpenLayers. ControlOpenLayers. Control. ZoomToMaxExtent
U
 units
OpenLayers. LayerOpenLayers.Map
 url
OpenLayers.IconOpenLayers. Layer. ImageOpenLayers.TileOpenLayers. Tile. ImageOpenLayers. Tile.WFS
V
 viewPortDiv, OpenLayers.Map
 viewRequestID, OpenLayers.Map
W
 w, OpenLayers.Size
 wheelListener, OpenLayers. Handler. MouseWheel
 wrapDateLine, OpenLayers. Layer
X
 x
OpenLayers. Geometry. PointOpenLayers. Pixel
Y
 y, OpenLayers. Geometry. Point
Z
 zoom, OpenLayers.Map
+ +
{Array}
{OpenLayers.Feature}
{OpenLayers.Size}
{OpenLayers.Size} The image size in pixels
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.Size}
{OpenLayers.Size} null
{OpenLayers.Pixel}
{Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting.
{String}
{Object}
+ + + +
{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}
{OpenLayers.Control.TYPES} Controls can have a ‘type’.
TYPE_BUTTON.
+ + + +
{String} The layer map units.
{String} The map units.
{String} image url
{String} URL of the image to use
{String} url of the request
{String} The URL of the image being requested.
{String}
+ + + +
{HTMLDivElement} The element that represents the map viewport
{String} Used to store a unique identifier that changes when the map view changes.
+ + + +
{Number} width
{function}
{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/readme.txt b/readme.txt deleted file mode 100644 index fd23a71bbe..0000000000 --- a/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -Automatically generated OpenLayers API documentation is online: - - http://dev.openlayers.org/docs/overview-tree.html diff --git a/styles/2.css b/styles/2.css index 21314f3be6..a397119822 100644 --- a/styles/2.css +++ b/styles/2.css @@ -1,3 +1,20 @@ p { text-indent: 0; margin-bottom: 1em; } + +.MGroup { + font-variant: normal; + margin: 0.4em 0 0em 10px +} + +.MTitle { + font-variant: normal; +} + +.CGroup .CTitle { + font-variant: normal; +} + +.SGroup .SEntry { + font-variant: normal; +} \ No newline at end of file diff --git a/styles/main.css b/styles/main.css index a672a94920..c24541cf64 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");