Class Inset

An inset describes a rectangle by enumerating the distance from each side to the corresponding side of a reference rectangle. Therefore it does not hold coordinates, nor dimensions, only relative values for left, top, right and bottom. 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 Immutable.Record and thus can be updated using set(key, value), for example: inset.set("right", 15).

Example

Create and update an inset.

const inset = new NutrientViewer.Geometry.Inset({
  left: 5,
  top: 15,
  right: 10,
  bottom: 5
});
inset = inset.set("bottom", 7);
rect.bottom; // => 7

Param: args

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

Default

{ left: 0, top: 0, right: 0, bottom: 0 }

Hierarchy

Record<{ bottom: number; left: number; right: number; top: number }, this> & Readonly<
{ bottom: number; left: number; right: number; top: number },
>
- Inset

Index

Constructors

constructor

new Inset(
    values?:
        | Iterable<[string, any]>
        | Partial<{ bottom: number; left: number; right: number; top: number }>,
): NutrientViewer.Geometry.Inset
Parameters
- Optionalvalues:
  | Iterable<[string, any]>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
Returns NutrientViewer.Geometry.Inset
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).constructor

Properties

`Readonly`bottom

bottom: number

`Readonly`left

left: number

`Readonly`right

right: number

`Readonly`top

top: number

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof { bottom: number; left: number; right: number; top: number },
        number,
    ],
>
Returns IterableIterator<
    [
        keyof { bottom: number; left: number; right: number; top: number },
        number,
    ],
>
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).[iterator]

apply

apply(matrix: TransformationMatrix): NutrientViewer.Geometry.Inset
Applies a transformation to the inset. We will transform each of the corners represented by the inset and then find the max and min values to generate the resulting inset.
Parameters
- matrix: TransformationMatrix
Returns NutrientViewer.Geometry.Inset

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).asMutable

clear

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

Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).clear

delete

delete<
    K extends
        keyof { bottom: number; left: number; right: number; top: 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 { bottom: number; left: number; right: number; top: number }
Parameters
- key: K
Returns this
Alias
remove

Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).delete

deleteIn

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

Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).equals

get

get<
    K extends
        keyof { bottom: number; left: number; right: number; top: number },
>(
    key: K,
    notSetValue?: any,
): { bottom: number; left: number; right: number; top: 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 { bottom: number; left: number; right: number; top: number }
Parameters
- key: K
- OptionalnotSetValue: any
Returns { bottom: number; left: number; right: number; top: number }[K]
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).getIn

has

has(key: string): key is "left" | "right" | "top" | "bottom"
Parameters
- key: string
Returns key is "left" | "right" | "top" | "bottom"
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).has

hashCode

hashCode(): number
Returns number
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).hasIn

merge

merge(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: keyof { bottom: number; left: number; right: number; top: number },
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: keyof { bottom: number; left: number; right: number; top: number },
  ) => any
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).mergeWith

remove

remove<
    K extends
        keyof { bottom: number; left: number; right: number; top: number },
>(
    key: K,
): this
Type Parameters
- K extends keyof { bottom: number; left: number; right: number; top: number }
Parameters
- key: K
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).removeIn

set

set<
    K extends
        keyof { bottom: number; left: number; right: number; top: number },
>(
    key: K,
    value: { bottom: number; left: number; right: number; top: number }[K],
): this
Type Parameters
- K extends keyof { bottom: number; left: number; right: number; top: number }
Parameters
- key: K
- value: { bottom: number; left: number; right: number; top: number }[K]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).setIn

setScale

setScale(scale: number): NutrientViewer.Geometry.Inset
Returns a new inset with the provided scale applied to all properties.
Parameters
- scale: number
  The scale to apply to the inset.
Returns NutrientViewer.Geometry.Inset

toJS

toJS(): { bottom: any; left: any; right: any; top: 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 { bottom: any; left: any; right: any; top: any }
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).toJS

toJSON

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

Returns { bottom: number; left: number; right: number; top: number }
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).toJSON

toObject

toObject(): { bottom: number; left: number; right: number; top: number }
Shallowly converts this Record to equivalent JavaScript Object.

Returns { bottom: number; left: number; right: number; top: number }
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).toObject

toSeq

toSeq(): Keyed<
    keyof { bottom: number; left: number; right: number; top: number },
    number,
>
Returns Keyed<
    keyof { bottom: number; left: number; right: number; top: number },
    number,
>
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).toSeq

update

update<
    K extends
        keyof { bottom: number; left: number; right: number; top: number },
>(
    key: K,
    updater: (
        value: { bottom: number; left: number; right: number; top: number }[K],
    ) => { bottom: number; left: number; right: number; top: number }[K],
): this
Type Parameters
- K extends keyof { bottom: number; left: number; right: number; top: number }
Parameters
- key: K
- updater: (
  value: { bottom: number; left: number; right: number; top: number }[K],
  ) => { bottom: number; left: number; right: number; top: number }[K]
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).update

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).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 ImmutableRecord<IInset>({ /** * The `left` distance of the inset. This is equivalent to `x` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ left: 0, /** * The `top` distance of the inset. This is equivalent to `y` of a * {@link NutrientViewer.Geometry.Point}. * * @default 0 */ top: 0, /** * The `right` distance of the inset. * * @default 0 */ right: 0, /** * The `bottom` distance of the inset. * * @default 0 */ bottom: 0, }).withMutations

`Static`applyToRect

applyToRect(
inset: NutrientViewer.Geometry.Inset,
rect: NutrientViewer.Geometry.Rect,
): NutrientViewer.Geometry.Rect
Returns a new Rect by adding the provided inset values to the provided Rect.
Parameters
- inset: NutrientViewer.Geometry.Inset
  An Inset instance.
- rect: NutrientViewer.Geometry.Rect
  A Rect instance.
Returns NutrientViewer.Geometry.Rect
A new Rect.
Example
```
const rect = NutrientViewer.Geometry.Inset.applyToRect(
  rectangleAnnotation.cloudyBorderInset,
  rectangleAnnotation.boundingBox
);
```

`Static`fromRect

fromRect(rect: NutrientViewer.Geometry.Rect): NutrientViewer.Geometry.Inset
Parameters
- rect: NutrientViewer.Geometry.Rect
Returns NutrientViewer.Geometry.Inset

`Static`fromValue

fromValue(insetValue: number): NutrientViewer.Geometry.Inset
Returns a new inset using the provided vale for all properties.
Parameters
- insetValue: number
  An inset value to be applied to all the properties.
Returns NutrientViewer.Geometry.Inset
A new Inset.
Example
```
const inset = NutrientViewer.Geometry.Inset.fromValue(10);
// inset ->
// {
//    left: 10,
//    top: 10,
//    right: 10,
//    bottom: 10,
// }
```

Class Inset

Example

Param: args

Default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Geometry.Inset

Properties

Readonlybottom

Readonlyleft

Readonlyright

Readonlytop

Methods

[iterator]

Returns IterableIterator< [ keyof { bottom: number; left: number; right: number; top: number }, number, ],>

apply

Parameters

Returns NutrientViewer.Geometry.Inset

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

get

Type Parameters

Parameters

Returns { bottom: number; left: number; right: number; top: number }[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is "left" | "right" | "top" | "bottom"

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

`Readonly`bottom

`Readonly`left

`Readonly`right

`Readonly`top

Returns IterableIterator<
[
keyof { bottom: number; left: number; right: number; top: number },
number,
],
>

Returns Keyed<
keyof { bottom: number; left: number; right: number; top: number },
number,
>

`Static`applyToRect

`Static`fromRect

`Static`fromValue