Class Rect

A rect describes a rectangle in 2D space. It consists of a location (left and top) and dimensions (width and height). Provided values are defined in same units used by the page, point units. Point units are only equal to pixels when zoom value is 1.

It is an https://facebook.github.io/immutable-js/docs/#/Record|Immutable.Record and thus can be updated using set(key, value), for example: rect.set("left", 20).

Example

Create and update a rect.

const rect = new NutrientViewer.Geometry.Rect({
  left: 10,
  top: 20,
  width: 30,
  height: 40
});
rect = rect.set("left", 20);
rect.left; // => 20

Param: args

An object used to initialize the Point. If left, top, width or height is omitted, 0 will be used instead.

Default

{ left: 0, top: 0, width: 0, height: 0 }

Hierarchy

Record<{ height?: number; left?: number; top?: number; width?: number }, this> & Readonly<
{ height?: number; left?: number; top?: number; width?: number },
>
- Rect

Constructors

constructor

new Rect(
    options?: {
        height?: number;
        left?: number;
        top?: number;
        width?: number;
    },
): NutrientViewer.Geometry.Rect
Parameters
- Optionaloptions: { height?: number; left?: number; top?: number; width?: number }
Returns NutrientViewer.Geometry.Rect
Overrides (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).constructor

Properties

height

height: number

The height of the rect. This is equivalent to height of a Geometry.Size.

Default

left

left: number

The left distance of the rect. This is equivalent to x of a Geometry.Point.

Default

top

top: number

The top distance of the rect. This is equivalent to y of a Geometry.Point.

Default

width

width: number

The width of the rect. This is equivalent to width of a Geometry.Size.

Default

`Static`defaultValues

defaultValues: IObject = ...

Accessors

bottom

get bottom(): number
Computes the bottom point in the rect by adding top and height.

Returns number

right

get right(): number
Computes the right point in the rect by adding left and width.

Returns number

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof { height?: number; left?: number; top?: number; width?: number },
        undefined | number,
    ],
>
Returns IterableIterator<
    [
        keyof { height?: number; left?: number; top?: number; width?: number },
        undefined | number,
    ],
>
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).[iterator]

apply

apply(matrix: TransformationMatrix): NutrientViewer.Geometry.Rect
Applies a transformation to the rect. We will translate [top, left] like a 2D vector but only apply the scaling to the dimension [width, height]
Parameters
- matrix: TransformationMatrix
Returns NutrientViewer.Geometry.Rect

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).clear

delete

delete<
    K extends
        keyof { height?: number; left?: number; top?: number; width?: number },
>(
    key: K,
): this
Returns a new instance of this Record type with the value for the specific key set to its default value.
Type Parameters
- K extends keyof { height?: number; left?: number; top?: number; width?: number }
Parameters
- key: K
Returns this
Alias
remove

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).delete

deleteIn

deleteIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).equals

expandToIncludePoints

expandToIncludePoints(
...points: NutrientViewer.Geometry.Point[],
): NutrientViewer.Geometry.Rect

Expand the rect to include the list of points.

Parameters

...points: NutrientViewer.Geometry.Point[]

Returns NutrientViewer.Geometry.Rect

A new Rect.

Example

const rect = NutrientViewer.Geometry.Rect({
  left: 10,
  top: 10,
  width: 10,
  height: 10
})

const newRect = rect.expandToIncludePoints(new NutrientViewer.Geometry.Point({ x: 30, y: 30 }));
// => Rect {left: 10, top: 10, width: 30, height: 30}

get

get<
    K extends
        keyof { height?: number; left?: number; top?: number; width?: number },
>(
    key: K,
    notSetValue?: any,
): { height?: number; left?: number; top?: number; width?: number }[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
Type Parameters
- K extends keyof { height?: number; left?: number; top?: number; width?: number }
Parameters
- key: K
- OptionalnotSetValue: any
Returns { height?: number; left?: number; top?: number; width?: number }[K]
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).get

getCenter

getCenter(): NutrientViewer.Geometry.Point
Returns the NutrientViewer.Geometry.Point that is the center of this rect.

Returns NutrientViewer.Geometry.Point
A point that is on the center of this rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
rect.getCenter(); // => Point {left: 15, top: 15}
```

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).getIn

getLocation

getLocation(): NutrientViewer.Geometry.Point
Returns the NutrientViewer.Geometry.Point that is the upper-left corner of this rect.

Returns NutrientViewer.Geometry.Point
A point that is on the upper-left corner of this rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
rect.getLocation(); // => Point {left: 10, top: 10}
```

getSize

getSize(): NutrientViewer.Geometry.Size

Returns the NutrientViewer.Geometry.Size of the rect.

Returns NutrientViewer.Geometry.Size

The size of the rect.

Example

const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
rect.getSize(); // => Size {width: 10, height: 10}

grow

grow(growth: number): NutrientViewer.Geometry.Rect
Grows the rect by growth on every side but keeps the center of the Rect at the same position.
Parameters
- growth: number
  The growth factor. It will be applied on every side, so the new width and height will increase by two times this factor.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
rect.grow(5); // => Rect {left: 5, top: 5, width: 20, height: 20}
```

has

has(key: string): key is "width" | "height" | "left" | "top"
Parameters
- key: string
Returns key is "width" | "height" | "left" | "top"
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).has

hashCode

hashCode(): number
Returns number
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).hasIn

isPointInside

isPointInside(point: NutrientViewer.Geometry.Point): boolean

Test if a point is within the rect. This can be used for hit testing.

Parameters

point: NutrientViewer.Geometry.Point
The point that should be tested.

Returns boolean

true if the point is inside, false otherwise.

Example

const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
rect.isPointInside(new NutrientViewer.Geometry.Point({ x: 15, y: 15 })); // => true
rect.isPointInside(new NutrientViewer.Geometry.Point({ x: 25, y: 25 })); // => false

isRectInside

isRectInside(otherRect: NutrientViewer.Geometry.Rect): boolean

Test if a rect is completely inside this rect.

Parameters

otherRect: NutrientViewer.Geometry.Rect
The rect that should be tested.

Returns boolean

true if the rect is inside, false otherwise.

Example

const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });

const insideRect = new NutrientViewer.Geometry.Rect({ left: 12, top: 12, width: 5, height: 5 });
const overlappingRect = new NutrientViewer.Geometry.Rect({ left: 5, top: 5, width: 10, height: 10 });
const outsideRect = new NutrientViewer.Geometry.Rect({ left: 0, top: 0, width: 5, height: 5 });

rect.isRectInside(insideRect); // => true
rect.isRectInside(overlappingRect); // => false
rect.isRectInside(outsideRect); // => false

isRectOverlapping

isRectOverlapping(other: NutrientViewer.Geometry.Rect): boolean

Test if the union area of two rects is greater than zero.

Parameters

other: NutrientViewer.Geometry.Rect
The rect that should be tested.

Returns boolean

true if the rect is overlapping, false otherwise.

Example

const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });

const insideRect = new NutrientViewer.Geometry.Rect({ left: 12, top: 12, width: 5, height: 5 });
const overlappingRect = new NutrientViewer.Geometry.Rect({ left: 5, top: 5, width: 10, height: 10 });
const outsideRect = new NutrientViewer.Geometry.Rect({ left: 0, top: 0, width: 5, height: 5 });

rect.isRectOverlapping(insideRect); // => true
rect.isRectOverlapping(overlappingRect); // => true
rect.isRectOverlapping(outsideRect); // => false

merge

merge(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { height?: number; left?: number; top?: number; width?: number },
        >
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ height?: number; left?: number; top?: number; width?: number }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { height?: number; left?: number; top?: number; width?: number },
        >
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ height?: number; left?: number; top?: number; width?: number }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { height?: number; left?: number; top?: number; width?: number },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ height?: number; left?: number; top?: number; width?: number }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: keyof {
            height?: number;
            left?: number;
            top?: number;
            width?: number;
        },
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            { height?: number; left?: number; top?: number; width?: number },
        >
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: keyof { height?: number; left?: number; top?: number; width?: number },
  ) => any
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ height?: number; left?: number; top?: number; width?: number }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).mergeWith

normalize

normalize(): NutrientViewer.Geometry.Rect
Normalizes the Rect. In case of either a negative width or a negative height, the position will be updated so that the location is again the top, left point of the rectangle.

Returns NutrientViewer.Geometry.Rect

remove

remove<
    K extends
        keyof { height?: number; left?: number; top?: number; width?: number },
>(
    key: K,
): this
Type Parameters
- K extends keyof { height?: number; left?: number; top?: number; width?: number }
Parameters
- key: K
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).removeIn

round

round(): NutrientViewer.Geometry.Rect
Rounds all coordinates to whole numbers. This implementation uses Math.round for all coordinates. The resulting Rect might no longer overlap the source Rect.

Returns NutrientViewer.Geometry.Rect
A new rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10.5, top: 15.5, width: 20.5, height: 25.5 });
rect.round(); // => Rect {left: 11, top: 16, width: 21, height: 26}
```

roundOverlap

roundOverlap(): NutrientViewer.Geometry.Rect
Rounds all coordinates to whole numbers. The resulting Rect will always overlap the source Rect.

The location (left and top) will be rounded to a number which is smaller than or equal to the current value.

The size (width and height) will be rounded to a number which is greater than or equal to the current value.

Returns NutrientViewer.Geometry.Rect
A new rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10.5, top: 15.5, width: 20.5, height: 25.5 });
rect.roundOverlap(); // => Rect {left: 10, top: 15, width: 21, height: 26}
```

scale

scale(sx: number, sy?: number): NutrientViewer.Geometry.Rect
Scales all values by the given sx and sy factor. If only sx is set and sy not defined, it will scale the values by sx.
Parameters
- sx: number
  Scale value for the left and width value. If sy is not set, this scale will also be applied to top and height.
- Optionalsy: number
  Scale value for the top an height value.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
rect.scale(2); // => Rect {left: 20, top: 20, width: 20, height: 20}
```

set

set<
    K extends
        keyof { height?: number; left?: number; top?: number; width?: number },
>(
    key: K,
    value: { height?: number; left?: number; top?: number; width?: number }[K],
): this
Type Parameters
- K extends keyof { height?: number; left?: number; top?: number; width?: number }
Parameters
- key: K
- value: { height?: number; left?: number; top?: number; width?: number }[K]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).setIn

setLocation

setLocation(
location: NutrientViewer.Geometry.Point,
): NutrientViewer.Geometry.Rect
Updates the location of the rect by modifying left and top.
Parameters
- location: NutrientViewer.Geometry.Point
  The new location for the rect.
Returns NutrientViewer.Geometry.Rect
A new Rect with left and top updated.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 10, height: 10 });
var nextLocation = new NutrientViewer.Geometry.Point({ x: 20, y: 30 });

rect.setLocation(nextLocation); // => Rect {left: 20, top: 30, width: 10, height: 10}
```

toJS

toJS(): { height?: any; left?: any; top?: any; width?: any }
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns { height?: any; left?: any; top?: any; width?: any }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).toJS

toJSON

toJSON(): { height?: number; left?: number; top?: number; width?: number }
Shallowly converts this Record to equivalent native JavaScript Object.

Returns { height?: number; left?: number; top?: number; width?: number }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).toJSON

toObject

toObject(): { height?: number; left?: number; top?: number; width?: number }
Shallowly converts this Record to equivalent JavaScript Object.

Returns { height?: number; left?: number; top?: number; width?: number }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).toObject

toSeq

toSeq(): Keyed<
    keyof { height?: number; left?: number; top?: number; width?: number },
    undefined | number,
>
Returns Keyed<
    keyof { height?: number; left?: number; top?: number; width?: number },
    undefined | number,
>
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).toSeq

translate

translate(point: NutrientViewer.Geometry.Point): NutrientViewer.Geometry.Rect
Translates the location of the rect by a point.
Parameters
- point: NutrientViewer.Geometry.Point
  A point that describes the translation distance.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10 });
rect.translate(new NutrientViewer.Geometry.Point({ x: 5, y: -5})); // => Rect {left: 15, top: 5, width: 0, height: 0}
```

translateX

translateX(tx: number): NutrientViewer.Geometry.Rect
Translates the horizontal location of the rect by a number.
Parameters
- tx: number
  A number to translate the left value.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10 });
rect.translateX(5); // => Rect {left: 15, top: 10, width: 0, height: 0}
```

translateY

translateY(ty: number): NutrientViewer.Geometry.Rect
Translates the vertical location of the rect by a number.
Parameters
- ty: number
  A number to translate the top value.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = new NutrientViewer.Geometry.Rect({ left: 10, top: 10 });
point.translateY(5); // => Rect {left: 10, top: 15, width: 0, height: 0}
```

update

update<
    K extends
        keyof { height?: number; left?: number; top?: number; width?: number },
>(
    key: K,
    updater: (
        value: { height?: number; left?: number; top?: number; width?: number }[K],
    ) => { height?: number; left?: number; top?: number; width?: number }[K],
): this
Type Parameters
- K extends keyof { height?: number; left?: number; top?: number; width?: number }
Parameters
- key: K
- updater: (
  value: { height?: number; left?: number; top?: number; width?: number }[K],
  ) => { height?: number; left?: number; top?: number; width?: number }[K]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).update

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).wasAltered

withMutations

withMutations(mutator: (mutable: this) => any): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
- mutator: (mutable: this) => any
Returns this
See
Map#withMutations

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<IRect>).withMutations

`Static`areRectsCloserThan

areRectsCloserThan(
    a: NutrientViewer.Geometry.Rect,
    b: NutrientViewer.Geometry.Rect,
    distance: number,
): boolean
Parameters
- a: NutrientViewer.Geometry.Rect
- b: NutrientViewer.Geometry.Rect
- distance: number
Returns boolean

`Static`areVerticallyAligned

areVerticallyAligned(
    a: NutrientViewer.Geometry.Rect,
    b: NutrientViewer.Geometry.Rect,
    thresholdDistance: number,
): boolean
Parameters
- a: NutrientViewer.Geometry.Rect
- b: NutrientViewer.Geometry.Rect
- thresholdDistance: number
Returns boolean

`Static`fromClientRect

fromClientRect(rect: ClientRect): NutrientViewer.Geometry.Rect
Creates a new rect from a DOM ClientRect.
Parameters
- rect: ClientRect
  A DOM ClientRect.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = NutrientViewer.Geometry.Rect.fromClientRect(
  element.getBoundingClientRect()
);
```

`Static`fromInset

fromInset(inset: NutrientViewer.Geometry.Inset): NutrientViewer.Geometry.Rect
Parameters
- inset: NutrientViewer.Geometry.Inset
Returns NutrientViewer.Geometry.Rect

`Static`fromPoints

fromPoints(
...points: NutrientViewer.Geometry.Point[],
): NutrientViewer.Geometry.Rect

Creates a new rect from four points.

Parameters

...points: NutrientViewer.Geometry.Point[]
An array of four points.

Returns NutrientViewer.Geometry.Rect

A new Rect.

Example

const rect = NutrientViewer.Geometry.Rect.fromPoints(
 new NutrientViewer.Geometry.Point({ x: 10, y: 10 }),
 new NutrientViewer.Geometry.Point({ x: 20, y: 10 }),
 new NutrientViewer.Geometry.Point({ x: 20, y: 20 }),
 new NutrientViewer.Geometry.Point({ x: 10, y: 20 })
 );

 @public

`Static`getCenteredRect

getCenteredRect(
inner: NutrientViewer.Geometry.Size,
outer: NutrientViewer.Geometry.Size,
): NutrientViewer.Geometry.Rect
Parameters
- inner: NutrientViewer.Geometry.Size
- outer: NutrientViewer.Geometry.Size
Returns NutrientViewer.Geometry.Rect

`Static`union

union(
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>,
): NutrientViewer.Geometry.Rect

Creates a rect that surrounds all rects in the supplied NutrientViewer.Immutable.List.

This can be used to calculate the bounding box of a list of rects.

Parameters

rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>
An immutable list of rects.

Returns NutrientViewer.Geometry.Rect

A new Rect.

Example

const rects = NutrientViewer.Immutable.List([
  new NutrientViewer.Geometry.Rect({ left: 14, top: 50, width: 50, height: 50 }),
  new NutrientViewer.Geometry.Rect({ left: 70, top: 20, width: 98, height: 99 }),
  new NutrientViewer.Geometry.Rect({ left: 14, top: 13, width: 15, height: 16 })
]);

const unionRect = NutrientViewer.Geometry.Rect.union(rects); // => Rect {left: 14, top: 13, width: 154, height: 106}

Class Rect

Example

Param: args

Default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Geometry.Rect

Properties

height

Default

left

Default

top

Default

width

Default

StaticdefaultValues

Accessors

bottom

Returns number

right

Returns number

Methods

[iterator]

Returns IterableIterator< [ keyof { height?: number; left?: number; top?: number; width?: number }, undefined | number, ],>

apply

Parameters

Returns NutrientViewer.Geometry.Rect

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

expandToIncludePoints

Parameters

Returns NutrientViewer.Geometry.Rect

Example

get

Type Parameters

Parameters

Returns { height?: number; left?: number; top?: number; width?: number }[K]

Type Parameters

Parameters

Returns T

getCenter

Returns NutrientViewer.Geometry.Point

Example

getIn

Parameters

Returns any

getLocation

Returns NutrientViewer.Geometry.Point

Example

getSize

Returns NutrientViewer.Geometry.Size

Example

grow

Parameters

`Static`defaultValues

Returns IterableIterator<
[
keyof { height?: number; left?: number; top?: number; width?: number },
undefined | number,
],
>