Box (Closure Library API Documentation

Top.

right :

Right.

bottom :

Bottom.

left :

Left.

Instance Methods

Public Protected Private

Defined in goog.math.Box

clone() ⇒

Creates a copy of the box with the same dimensions.

Returns:

A clone of this Box.

code »

contains(other) ⇒

Returns whether the box contains a coordinate or another box.

Arguments:

other :

(goog.math.Box | goog.math.Coordinate | null)

A Coordinate or a Box.

Returns:

Whether the box contains the coordinate or other box.

code »

expand(top, opt_right, opt_bottom, opt_left) ⇒

Expands box with the given margins.

Arguments:

top :

(goog.math.Box | null | number)

Top margin or box with all margins.

opt_right :

(number | undefined)

Right margin.

opt_bottom :

(number | undefined)

Bottom margin.

opt_left :

(number | undefined)

Left margin.

Returns:

A reference to this Box.

code »

expandToInclude(box)

Expand this box to include another box. NOTE(user): This is used in code that needs to be very fast, please don't add functionality to this function at the expense of speed (variable arguments, accepting multiple argument types, etc).

Arguments:

box :

(goog.math.Box | null)

The box to include in this one.

code »

toString() ⇒

string

Returns a nice string representing the box.

Returns:

string

In the form (50t, 73r, 24b, 13l).

code »

Instance Properties

Defined in goog.math.Box

	bottom : number Bottom	Code »
	left : number Left	Code »
	right : number Right	Code »
	top : number Top	Code »

Static Methods

goog.math.Box.boundingBox(var_args) ⇒

Creates a Box by bounding a collection of goog.math.Coordinate objects

Arguments:

var_args :

(goog.math.Coordinate | null | undefined)

Coordinates to be included inside the box.

Returns:

A Box containing all the specified Coordinates.

code »

goog.math.Box.contains(box, other) ⇒

Returns whether a box contains a coordinate or another box.

Arguments:

box :

(goog.math.Box | null)

A Box.

other :

(goog.math.Box | goog.math.Coordinate | null)

A Coordinate or a Box.

Returns:

Whether the box contains the coordinate or other box.

code »

goog.math.Box.distance(box, coord) ⇒

Returns the distance between a coordinate and the nearest corner/side of a box. Returns zero if the coordinate is inside the box.

Arguments:

box :

(goog.math.Box | null)

A Box.

coord :

(goog.math.Coordinate | null)

A Coordinate.

Returns:

The distance between coord and the nearest corner/side of box, or zero if coord is inside box.

code »

goog.math.Box.equals(a, b) ⇒

Compares boxes for equality.

Arguments:

a :

(goog.math.Box | null)

A Box.

b :

(goog.math.Box | null)

A Box.

Returns:

True iff the boxes are equal, or if both are null.

code »

goog.math.Box.intersects(a, b) ⇒

Returns whether two boxes intersect.

Arguments:

a :

(goog.math.Box | null)

A Box.

b :

(goog.math.Box | null)

A second Box.

Returns:

Whether the boxes intersect.

code »

goog.math.Box.intersectsWithPadding(a, b, padding) ⇒

Returns whether two boxes would intersect with additional padding.

Arguments:

a :

(goog.math.Box | null)

A Box.

b :

(goog.math.Box | null)

A second Box.

padding :

The additional padding.

Returns: