goog.math.Box

Provided By	`goog.math.Box`

Class for representing a box. A box is specified as a top, right, bottom, and left. A box is useful for representing margins and padding.

This class assumes 'screen coordinates': larger Y coordinates are further from the top of the screen.

new Box( `top`, `right`, `bottom`, `left` )

Parameters

`top`	`number`
	Top.
`right`	`number`
	Right.
`bottom`	`number`
	Bottom.
`left`	`number`
	Left.

VIEW SOURCE

Instance Methods

Rounds the fields to the next larger integer values.

Parameters

None.

Returns

goog.math.Box

This box with ceil'd fields.

VIEW SOURCE

Creates a copy of the box with the same dimensions.

Parameters

None.

Returns

goog.math.Box

A clone of this Box.

VIEW SOURCE

Returns whether the box contains a coordinate or another box.

Parameters

`other`	`(goog.math.Coordinate\|goog.math.Box\|null)`
	A Coordinate or a Box.

Returns

boolean

Whether the box contains the coordinate or other box.

VIEW SOURCE

Expands box with the given margins.

Parameters

`top`	`(number\|goog.math.Box\|null)`
	Top margin or box with all margins.
`opt_right`	`number=`
	Right margin.
`opt_bottom`	`number=`
	Bottom margin.
`opt_left`	`number=`
	Left margin.

Returns

goog.math.Box

A reference to this Box.

VIEW SOURCE

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

Parameters

`box`	`(goog.math.Box\|null)`
	The box to include in this one.

VIEW SOURCE

Expand this box to include the coordinate.

Parameters

`coord`	`goog.math.Coordinate`
	The coordinate to be included inside the box.

VIEW SOURCE

Rounds the fields to the next smaller integer values.

Parameters

None.

Returns

goog.math.Box

This box with floored fields.

VIEW SOURCE

Parameters

None.

Returns

number

height The height of this Box.

VIEW SOURCE

Parameters

None.

Returns

number

width The width of this Box.

VIEW SOURCE

Rounds the fields to nearest integer values.

Parameters

None.

Returns

goog.math.Box

This box with rounded fields.

VIEW SOURCE

Scales this coordinate by the given scale factors. The x and y dimension values are scaled by sx and opt_sy respectively. If opt_sy is not given, then sx is used for both x and y.

Parameters

`sx`	`number`
	The scale factor to use for the x dimension.
`opt_sy`	`number=`
	The scale factor to use for the y dimension.

Returns

goog.math.Box

This box after scaling.

VIEW SOURCE

Returns a nice string representing the box.

Parameters

None.

Returns

string

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

VIEW SOURCE

Translates this box by the given offsets. If a goog.math.Coordinate is given, then the left and right values are translated by the coordinate's x value and the top and bottom values are translated by the coordinate's y value. Otherwise, tx and opt_ty are used to translate the x and y dimension values.

Parameters

`tx`	`(number\|goog.math.Coordinate\|null)`
	The value to translate the x dimension values by or the coordinate to translate this box by.
`opt_ty`	`number=`
	The value to translate y dimension values by.

Returns

goog.math.Box

This box after translating.

VIEW SOURCE

Instance Properties

Bottom

Left

Right

Top

Static Functions

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

Parameters

`var_args`	`...(goog.math.Coordinate\|null)`
	Coordinates to be included inside the box.

Returns

goog.math.Box

A Box containing all the specified Coordinates.

VIEW SOURCE

Returns whether a box contains a coordinate or another box.

Parameters

`box`	`(goog.math.Box\|null)`
	A Box.
`other`	`(goog.math.Coordinate\|goog.math.Box\|null)`
	A Coordinate or a Box.

Returns

boolean

Whether the box contains the coordinate or other box.

VIEW SOURCE

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

Parameters

`box`	`(goog.math.Box\|null)`
	A Box.
`coord`	`(goog.math.Coordinate\|null)`
	A Coordinate.

Returns

number

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

VIEW SOURCE

Compares boxes for equality.

Parameters

`a`	`(goog.math.Box\|null)`
	A Box.
`b`	`(goog.math.Box\|null)`
	A Box.

Returns

boolean

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

VIEW SOURCE

Returns whether two boxes intersect.

Parameters

`a`	`(goog.math.Box\|null)`
	A Box.
`b`	`(goog.math.Box\|null)`
	A second Box.

Returns

boolean

Whether the boxes intersect.

VIEW SOURCE

Returns whether two boxes would intersect with additional padding.

Parameters

`a`	`(goog.math.Box\|null)`
	A Box.
`b`	`(goog.math.Box\|null)`
	A second Box.
`padding`	`number`
	The additional padding.

Returns

boolean

Whether the boxes intersect.

VIEW SOURCE

Returns the relative x position of a coordinate compared to a box. Returns zero if the coordinate is inside the box.

Parameters

`box`	`(goog.math.Box\|null)`
	A Box.
`coord`	`(goog.math.Coordinate\|null)`
	A Coordinate.

Returns

number

The x position of coord relative to the nearest side of box, or zero if coord is inside box.

VIEW SOURCE

Returns the relative y position of a coordinate compared to a box. Returns zero if the coordinate is inside the box.

Parameters

`box`	`(goog.math.Box\|null)`
	A Box.
`coord`	`(goog.math.Coordinate\|null)`
	A Coordinate.

Returns

number

The y position of coord relative to the nearest side of box, or zero if coord is inside box.

VIEW SOURCE

goog.math.Box

new Box( `top`, `right`, `bottom`, `left` )

Instance Methods

`this.`ceil() `→` `goog.math.Box`

`this.`clone() `→` `goog.math.Box`

`this.`contains( `other` ) `→` `boolean`

`this.`expand( `top`, `opt_right`, `opt_bottom`, `opt_left` ) `→` `goog.math.Box`

`this.`expandToInclude( `box` ) `→` `void`

`this.`expandToIncludeCoordinate( `coord` ) `→` `void`

`this.`floor() `→` `goog.math.Box`

`this.`getHeight() `→` `number`

`this.`getWidth() `→` `number`

`this.`round() `→` `goog.math.Box`

`this.`scale( `sx`, `opt_sy` ) `→` `goog.math.Box`

`this.`toString() `→` `string`

`this.`translate( `tx`, `opt_ty` ) `→` `goog.math.Box`

Instance Properties

`this.`bottom `→` `number`

`this.`left `→` `number`

`this.`right `→` `number`

`this.`top `→` `number`

Static Functions

Box.boundingBox( `...var_args` ) `→` `goog.math.Box`

Box.contains( `box`, `other` ) `→` `boolean`

Box.distance( `box`, `coord` ) `→` `number`

Box.equals( `a`, `b` ) `→` `boolean`

Box.intersects( `a`, `b` ) `→` `boolean`

Box.intersectsWithPadding( `a`, `b`, `padding` ) `→` `boolean`

Box.relativePositionX( `box`, `coord` ) `→` `number`

Box.relativePositionY( `box`, `coord` ) `→` `number`

goog.math.Box

new Box( top, right, bottom, left )

Instance Methods

this.ceil() → goog.math.Box

this.clone() → goog.math.Box

this.contains( other ) → boolean

this.expand( top, opt_right, opt_bottom, opt_left ) → goog.math.Box

this.expandToInclude( box ) → void

this.expandToIncludeCoordinate( coord ) → void

this.floor() → goog.math.Box

this.getHeight() → number

this.getWidth() → number

this.round() → goog.math.Box

this.scale( sx, opt_sy ) → goog.math.Box

this.toString() → string

this.translate( tx, opt_ty ) → goog.math.Box

Instance Properties

this.bottom → number

this.left → number

this.right → number

this.top → number

Static Functions

Box.boundingBox( ...var_args ) → goog.math.Box

Box.contains( box, other ) → boolean

Box.distance( box, coord ) → number

Box.equals( a, b ) → boolean

Box.intersects( a, b ) → boolean

Box.intersectsWithPadding( a, b, padding ) → boolean

Box.relativePositionX( box, coord ) → number

Box.relativePositionY( box, coord ) → number

new Box( `top`, `right`, `bottom`, `left` )

`this.`ceil() `→` `goog.math.Box`

`this.`clone() `→` `goog.math.Box`

`this.`contains( `other` ) `→` `boolean`

`this.`expand( `top`, `opt_right`, `opt_bottom`, `opt_left` ) `→` `goog.math.Box`

`this.`expandToInclude( `box` ) `→` `void`

`this.`expandToIncludeCoordinate( `coord` ) `→` `void`

`this.`floor() `→` `goog.math.Box`

`this.`getHeight() `→` `number`

`this.`getWidth() `→` `number`

`this.`round() `→` `goog.math.Box`

`this.`scale( `sx`, `opt_sy` ) `→` `goog.math.Box`

`this.`toString() `→` `string`

`this.`translate( `tx`, `opt_ty` ) `→` `goog.math.Box`

`this.`bottom `→` `number`

`this.`left `→` `number`

`this.`right `→` `number`

`this.`top `→` `number`

Box.boundingBox( `...var_args` ) `→` `goog.math.Box`

Box.contains( `box`, `other` ) `→` `boolean`

Box.distance( `box`, `coord` ) `→` `number`

Box.equals( `a`, `b` ) `→` `boolean`

Box.intersects( `a`, `b` ) `→` `boolean`

Box.intersectsWithPadding( `a`, `b`, `padding` ) `→` `boolean`

Box.relativePositionX( `box`, `coord` ) `→` `number`

Box.relativePositionY( `box`, `coord` ) `→` `number`