Class Bounds

Constructors

constructor

new Bounds(left?: number, bottom?: number, right?: number, top?: number): Bounds
Construct a new bounds object. Coordinates can either be passed as four arguments, or as a single argument.
Parameters
- Optionalleft: number
- Optionalbottom: number
- Optionalright: number
- Optionaltop: number
Returns Bounds
new Bounds(bounds: number[]): Bounds
Construct a new bounds object. Coordinates can either be passed as four arguments, or as a single argument.
Parameters
- bounds: number[]
Returns Bounds

Properties

bottom

bottom: number

Minimum vertical coordinate.

left

left: number

Minimum horizontal coordinate.

right

right: number

Maximum horizontal coordinate.

top

top: number

Maximum vertical coordinate.

`Static`CLASS_NAME

CLASS_NAME: string

Methods

add

add(x: number, y: number): Bounds
Shifts the coordinates of the bound by the given horizontal and vertical deltas.
Parameters
- x: number
- y: number
Returns Bounds

clone

clone(): Bounds
Create a cloned instance of this bounds.

Returns Bounds

contains

contains(x: number, y: number, inclusive?: boolean): boolean
Returns whether the bounds object contains the given x and y.
Parameters
- x: number
- y: number
- Optionalinclusive: boolean
Returns boolean

containsBounds

containsBounds(bounds: Bounds, partial?: boolean, inclusive?: boolean): boolean
Returns whether the bounds object contains the given <OpenLayers.Bounds>.
Parameters
- bounds: Bounds
- Optionalpartial: boolean
- Optionalinclusive: boolean
Returns boolean

containsLonLat

containsLonLat(ll: LonLat, options: BoundsOptions): boolean
Returns whether the bounds object contains the given <OpenLayers.LonLat>.
Parameters
- ll: LonLat
- options: BoundsOptions
Returns boolean
containsLonLat(ll: {}, options: BoundsOptions): boolean
Returns whether the bounds object contains the given <OpenLayers.LonLat>.
Parameters
- ll: {}
- options: BoundsOptions
Returns boolean

containsPixel

containsPixel(px: Pixel, inclusive: boolean): boolean
Returns whether the bounds object contains the given <OpenLayers.Pixel>.
Parameters
- px: Pixel
- inclusive: boolean
Returns boolean

determineQuadrant

determineQuadrant(lonlat: LonLat): string
Returns the the quadrant ("br", "tr", "tl", "bl") in which the given <OpenLayers.LonLat> lies.
Parameters
- lonlat: LonLat
Returns string

equals

equals(bounds: Bounds): boolean
Test a two bounds for equivalence.
Parameters
- bounds: Bounds
Returns boolean

extend

extend(object: LonLat): void
Extend the bounds.
Parameters
- object: LonLat
Returns void
extend(object: Point): void
Extend the bounds.
Parameters
- object: Point
Returns void
extend(object: Point | Bounds | LonLat): void
Extend the bounds.
Parameters
- object: Point | Bounds | LonLat
Returns void

extendXY

extendXY(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void

getCenterLonLat

getCenterLonLat(): LonLat
Returns the LonLat object which represents the center of the bounds.

Returns LonLat

getCenterPixel

getCenterPixel(): Pixel
Returns the Pixel object which represents the center of the bounds.

Returns Pixel

getHeight

getHeight(): number
Returns the height of the bounds.

Returns number

getSize

getSize(): Size
Returns Size

getWidth

getWidth(): number
Returns the width of the bounds.

Returns number

intersectsBounds

intersectsBounds(bounds: Bounds, options?: BoundsOptions): boolean
Determine whether the target bounds intersects this bounds. Bounds are considered intersecting if any of their edges intersect or if one bounds contains the other.
Parameters
- bounds: Bounds
- Optionaloptions: BoundsOptions
Returns boolean

scale

scale(ratio: number, origin?: Pixel): Bounds
Scales the bounds around a pixel or lonlat. Note that the new bounds may return non-integer properties, even if a pixel is passed.
Parameters
- ratio: number
- Optionalorigin: Pixel
Returns Bounds
scale(ratio: number, origin?: LonLat): Bounds
Scales the bounds around a pixel or lonlat. Note that the new bounds may return non-integer properties, even if a pixel is passed.
Parameters
- ratio: number
- Optionalorigin: LonLat
Returns Bounds

toArray

toArray(reverseAxisOrder?: boolean): number[]
Returns an array representation of the bounds object.
Parameters
- OptionalreverseAxisOrder: boolean
Returns number[]

toBBOX

toBBOX(decimal?: number, reverseAxisOrder?: boolean): string
Returns a boundingbox-string representation of the bounds object.
Parameters
- Optionaldecimal: number
- OptionalreverseAxisOrder: boolean
Returns string

toGeometry

toGeometry(): Polygon
Create a new polygon geometry based on this bounds.

Returns Polygon

toString

toString(): string
Returns a string representation of the bounds object.

Returns string

transform

transform(source: Projection, dest: Projection): Bounds
Transform the Bounds object from source to dest.
Parameters
- source: Projection
- dest: Projection
Returns Bounds
transform(source: string, dest: string): Bounds
Transform the Bounds object from source to dest.
Parameters
- source: string
- dest: string
Returns Bounds

wrapDateLine

wrapDateLine(maxExtent: Bounds, options: WrapDateLineOptions): Bounds
Wraps the bounds object around the dateline.
Parameters
- maxExtent: Bounds
- options: WrapDateLineOptions
Returns Bounds

`Static`fromArray

fromArray(bbox: number[], reverseAxisOrder: boolean): Bounds
Alternative constructor that builds a new OpenLayers.Bounds from an array.
Parameters
- bbox: number[]
- reverseAxisOrder: boolean
Returns Bounds

`Static`fromSize

fromSize(size: Size): Bounds
Alternative constructor that builds a new OpenLayers.Bounds from a size.
Parameters
- size: Size
Returns Bounds

`Static`fromString

fromString(str: string, reverseAxisOrder: boolean): Bounds
Alternative constructor that builds a new OpenLayers.Bounds from a parameter string.
Parameters
- str: string
- reverseAxisOrder: boolean
Returns Bounds

`Static`oppositeQuadrant

oppositeQuadrant(quadrant: string): string
Get the opposite quadrant for a given quadrant string.
Parameters
- quadrant: string
Returns string