goog.math.Size

Provided By	`goog.math.Size`

Class for representing sizes consisting of a width and height. Undefined width and height support is deprecated and results in compiler warning.

new Size( `width`, `height` )

Parameters

`width`	`number`
	Width.
`height`	`number`
	Height.

VIEW SOURCE

Instance Methods

Parameters

None.

Returns

number

The area of the size (width * height).

VIEW SOURCE

Parameters

None.

Returns

number

The ratio of the size's width to its height.

VIEW SOURCE

Clamps the width and height parameters upward to integer values.

Parameters

None.

Returns

goog.math.Size

This size with ceil'd components.

VIEW SOURCE

Parameters

None.

Returns

goog.math.Size

A new copy of the Size.

VIEW SOURCE

Parameters

`target`	`goog.math.Size`
	The target size.

Returns

boolean

True if this Size is the same size or smaller than the target size in both dimensions.

VIEW SOURCE

Clamps the width and height parameters downward to integer values.

Parameters

None.

Returns

goog.math.Size

This size with floored components.

VIEW SOURCE

Parameters

None.

Returns

number

The longer of the two dimensions in the size.

VIEW SOURCE

Parameters

None.

Returns

number

The shorter of the two dimensions in the size.

VIEW SOURCE

Parameters

None.

Returns

boolean

True if the size has zero area, false if both dimensions are non-zero numbers.

VIEW SOURCE

Parameters

None.

Returns

number

The perimeter of the size (width + height) * 2.

VIEW SOURCE

Rounds the width and height parameters to integer values.

Parameters

None.

Returns

goog.math.Size

This size with rounded components.

VIEW SOURCE

Scales this size by the given scale factors. The width and height are scaled by sx and opt_sy respectively. If opt_sy is not given, then sx is used for both the width and height.

Parameters

`sx`	`number`
	The scale factor to use for the width.
`opt_sy`	`number=`
	The scale factor to use for the height.

Returns

goog.math.Size

This Size object after scaling.

VIEW SOURCE

Uniformly scales the size to perfectly cover the dimensions of a given size. If the size is already larger than the target, it will be scaled down to the minimum size at which it still covers the entire target. The original aspect ratio will be preserved.

This function assumes that both Sizes contain strictly positive dimensions.

Parameters

`target`	`goog.math.Size`
	The target size.

Returns

goog.math.Size

This Size object, after optional scaling.

VIEW SOURCE

Uniformly scales the size to fit inside the dimensions of a given size. The original aspect ratio will be preserved.

This function assumes that both Sizes contain strictly positive dimensions.

Parameters

`target`	`goog.math.Size`
	The target size.

Returns

goog.math.Size

This Size object, after optional scaling.

VIEW SOURCE

Returns a nice string representing size.

Parameters

None.

Returns

string

In the form (50 x 73).

VIEW SOURCE

Instance Properties

Height

VIEW SOURCE

Width

VIEW SOURCE

Static Functions

Compares sizes for equality.

Parameters

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

Returns

boolean

True iff the sizes have equal widths and equal heights, or if both are null.

VIEW SOURCE

goog.math.Size

new Size( `width`, `height` )

Instance Methods

`this.`area() `→` `number`

`this.`aspectRatio() `→` `number`

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

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

`this.`fitsInside( `target` ) `→` `boolean`

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

`this.`getLongest() `→` `number`

`this.`getShortest() `→` `number`

`this.`isEmpty() `→` `boolean`

`this.`perimeter() `→` `number`

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

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

`this.`scaleToCover( `target` ) `→` `goog.math.Size`

`this.`scaleToFit( `target` ) `→` `goog.math.Size`

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

Instance Properties

`this.`height `→` `number`

`this.`width `→` `number`

Static Functions

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

goog.math.Size

new Size( width, height )

Instance Methods

this.area() → number

this.aspectRatio() → number

this.ceil() → goog.math.Size

this.clone() → goog.math.Size

this.fitsInside( target ) → boolean

this.floor() → goog.math.Size

this.getLongest() → number

this.getShortest() → number

this.isEmpty() → boolean

this.perimeter() → number

this.round() → goog.math.Size

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

this.scaleToCover( target ) → goog.math.Size

this.scaleToFit( target ) → goog.math.Size

this.toString() → string

Instance Properties

this.height → number

this.width → number

Static Functions

Size.equals( a, b ) → boolean

new Size( `width`, `height` )

`this.`area() `→` `number`

`this.`aspectRatio() `→` `number`

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

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

`this.`fitsInside( `target` ) `→` `boolean`

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

`this.`getLongest() `→` `number`

`this.`getShortest() `→` `number`

`this.`isEmpty() `→` `boolean`

`this.`perimeter() `→` `number`

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

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

`this.`scaleToCover( `target` ) `→` `goog.math.Size`

`this.`scaleToFit( `target` ) `→` `goog.math.Size`

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

`this.`height `→` `number`

`this.`width `→` `number`

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