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.