Size class

A Size describes a width and a height in two-dimensional coordinates. The width and height must both be non-negative.

Use the static functions Size.parse and Size.stringify to convert to and from a standard string representation that is independent of the current locale.

When an instance of this class is the value of a property of a GraphObject class or Diagram or CommandHandler or a Tool class, you should treat the object as if it were frozen or read-only -- you cannot modify its properties. This allows the property to return a value without allocating a new instance. If you need to do your own calculations with the value, call #copy to make a new instance with the same values that you can modify.

Many methods modify the object's properties and then return a reference to "this" object. The only instance method to allocate a new object is the #copy method. The static Size.parse method also allocates a new object.

The "Debug" implementation of this class is significantly slower than the "Release" implementation, mostly due to additional error checking.

You cannot inherit from this class.

Available extensions

Size$Typings

Annotations

@JS()
@staticInterop

Constructors

Size.new([num? w, num? h]): factory

Properties

hashCode → int: The hash code for this object.
no setterinherited
height ↔ num: Available on Size, provided by the Size$Typings extension
Gets or sets the height value of the Size. The value must not be negative.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
width ↔ num: Available on Size, provided by the Size$Typings extension
Gets or sets the width value of the Size. The value must not be negative.
getter/setter pair

Methods

copy() → Size: Available on Size, provided by the Size$Typings extension
Create a copy of this Size, with the same values. @expose @return {Size}
equals(Size s) → bool: Available on Size, provided by the Size$Typings extension
Indicates whether the given Size is equal to the current Size. @param {Size} s The Size to compare to the current Size. @return {boolean} True if the Sizes have the same width and height, false otherwise. @see #equalTo
equalsApprox(Size s) → bool: Available on Size, provided by the Size$Typings extension
(undocumented) True when the given Size is nearly equal to this Size. @param {Size} s The Size to compare to the current Size. @return {boolean} True if the two Sizes have Width and Height values that are equal with a tolerance of 0.5, false otherwise.
equalTo(num w, num h) → bool: Available on Size, provided by the Size$Typings extension
Indicates whether the given size is equal to this Size. @param {number} w the width. @param {number} h the height. @return {boolean} True if the Sizes have the same width and height, false otherwise. @see #equals
inflate(num w, num h) → Size: Available on Size, provided by the Size$Typings extension
Modify this Size so that its width and height are changed by the given distances. When the arguments are negative, this operation deflates this Size, but not beyond zero. @param {number} w The additional width, which must be a real number; may be negative. @param {number} h The additional height, which must be a real number; may be negative. @return {Rect} this.
isReal() → bool: Available on Size, provided by the Size$Typings extension
True if this Size has Width and Height values that are real numbers and not infinity. @return {boolean}
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
set(Size s) → Size: Available on Size, provided by the Size$Typings extension
Modify this Size so that its Width and Height values are the same as the given Size. @param {Size} s the given Size. @return {Size} this.
setTo(num w, num h) → Size: Available on Size, provided by the Size$Typings extension
Modify this Size with new Width and Height values. @param {number} w the width. @param {number} h the height. @return {Size} this.
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

alloc() → Size
free(Size temp) → void
parse(String str) → Size: This static function can be used to read in a Size from a string that was produced by Size.stringify.
stringify(Size val) → String: This static function can be used to write out a Size as a string that can be read by Size.parse.