I

ISize

Show Usages
Interface for an object that has a size in 2D coordinate space with double precision floating point size values.
Inheritance Hierarchy

Remarks

This interface provides read access to the size only, however this does not mean that an instance that implements ISize will always return the same values for the size properties. Often times the instance provides a dynamic read access to the current state of an instance. It depends on the context whether it is allowed to or even necessary to copy the state of the properties or whether the reference to the instance should always be used to query the values.

This is a convertible type that can be used with the following notation(s) in parameter lists, parameter objects or setters.

It is possible to specify an Array or plain Object to define the ISize:

[20, 20] // width, height
{ width: 20, height: 20 }

See Also

Developer's Guide

API

IMutableSize, MutableSize

Members

No filters for this type

Properties

height

: number
readonlyabstract
Gets the current height of this instance.
Depending on context, the values returned may change over time.
readonlyabstract

isEmpty

: boolean
readonly
Determines whether the specified size is empty.
ISize instances are considered empty if their width or height is less than 0.0d.
readonly

width

: number
readonlyabstract
Gets the current width of this instance.
Depending on context, the values returned may change over time.
readonlyabstract

Methods

toSize

(): Size
Creates a new Size instance with the current values of this size.

Return Value

Size
A new Size instance that has been initialized with the current values of size.

Static Methods

from

(sizeLike: Size): Size
static
Creates a Size instance from the given size-like object by performing automatic type conversion.
static

Parameters

sizeLike: Size
The object to convert to a Size.

Return Value

Size
The given sizeLike if it is already a Size, or a new instance initialized to the values found in sizeLike.