Size

A 2D size with width and height.

Properties

• aspect_ratio - Returns the aspect ratio (width / height).
• height - The vertical extent of the size.
• width - The horizontal extent of the size.

Methods

• copy - Returns a copy of this object with the specified properties overridden.
• from_height - Creates a Size with the given height and an infinite width.
• from_radius - Creates a square Size whose width and height are twice the given radius.
• from_width - Creates a Size with the given width and an infinite height.
• infinite - Creates a Size whose width and height are both positive infinity.
• is_finite - Checks if both dimensions are finite.
• is_infinite - Checks if either dimension is infinite.
• square - Creates a square Size where width and height are the same.
• zero - Creates a Size whose width and height are both 0.0.

Properties

buildaspect_ratioproperty

aspect_ratio: float

Returns the aspect ratio (width / height).

buildheightinstance-attribute

height: Number

The vertical extent of the size.

buildwidthinstance-attribute

width: Number

The horizontal extent of the size.

Methods

deployed_codecopy

copy(
    width: Number | None = None,
    height: Number | None = None,
) -> Size

Returns a copy of this object with the specified properties overridden.

deployed_codefrom_heightclassmethod

from_height(height: Number) -> Size

Creates a Size with the given height and an infinite width.

deployed_codefrom_radiusclassmethod

from_radius(radius: Number) -> Size

Creates a square Size whose width and height are twice the given radius.

deployed_codefrom_widthclassmethod

from_width(width: Number) -> Size

Creates a Size with the given width and an infinite height.

deployed_codeinfiniteclassmethod

infinite()

Creates a Size whose width and height are both positive infinity.

deployed_codeis_finite

is_finite() -> bool

Checks if both dimensions are finite.

deployed_codeis_infinite

is_infinite() -> bool

Checks if either dimension is infinite.

deployed_codesquareclassmethod

square(dimension: Number) -> Size

Creates a square Size where width and height are the same.

deployed_codezeroclassmethod

zero()

Creates a Size whose width and height are both 0.0.