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

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

Index

Constructors

constructor

Properties

bottom left right top

Constructors

constructor

new Inset(
    options?: {
        bottom?: number;
        left?: number;
        right?: number;
        top?: number;
    },
): NutrientViewer.Geometry.Inset
Parameters
- Optionaloptions: { bottom?: number; left?: number; right?: number; top?: number }
  - Optionalbottom?: number
    The bottom distance of the inset.
    
    Default
    0
  - Optionalleft?: number
    The left distance of the inset. This is equivalent to x of a NutrientViewer.Geometry.Point.
    
    Default
    0
  - Optionalright?: number
    The right distance of the inset.
    
    Default
    0
  - Optionaltop?: number
    The top distance of the inset. This is equivalent to y of a NutrientViewer.Geometry.Point.
    
    Default
    0
Returns NutrientViewer.Geometry.Inset
Inherited from Readonly<InsetData>.constructor

Properties

`Readonly`bottom

bottom: number = ...

The bottom distance of the inset.

Default

`Readonly`left

left: number = ...

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

Default

`Readonly`right

right: number = ...

The right distance of the inset.

Default

`Readonly`top

top: number = ...

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

Default

Methods

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

asMutable

asMutable(): this
Returns this
See
Map#asMutable

clear

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

Returns this

delete

delete<K extends "left" | "right" | "top" | "bottom">(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 "left" | "right" | "top" | "bottom"
Parameters
- key: K
Returns this
Alias
remove

deleteIn

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

equals

equals(other: unknown): boolean
Parameters
- other: unknown
Returns boolean

get

get<K extends "left" | "right" | "top" | "bottom">(
key: K,
): { 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 "left" | "right" | "top" | "bottom"
Parameters
- key: K
Returns { bottom: number; left: number; right: number; top: number }[K]

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
- keyPath: Iterable<unknown>
- OptionalnotSetValue: unknown
Returns unknown

has

has(key: unknown): boolean
Parameters
- key: unknown
Returns boolean

merge

merge(
    ...collections: Partial<
        { bottom: number; left: number; right: number; top: number },
    >[],
): this
Parameters
- ...collections: Partial<{ bottom: number; left: number; right: number; top: number }>[]
Returns this

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, unknown], any, any>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- keyPath: Iterable<unknown>
- ...collections: (
  | Iterable<[string, unknown], any, any>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this

mergeDeepWith

mergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- merger: (previous?: unknown, next?: unknown, key?: string) => unknown
- ...collections: (
  | Iterable<[string, unknown], any, any>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this

mergeIn

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- keyPath: Iterable<unknown>
- ...collections: (
  | Iterable<[string, unknown], any, any>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this

mergeWith

mergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Parameters
- merger: (previous?: unknown, next?: unknown, key?: string) => unknown
- ...collections: (
  | Iterable<[string, unknown], any, any>
  | Partial<{ bottom: number; left: number; right: number; top: number }>
  )[]
Returns this

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this

set

set<K extends "left" | "right" | "top" | "bottom">(
key: K,
value: { bottom: number; left: number; right: number; top: number }[K],
): this
Type Parameters
- K extends "left" | "right" | "top" | "bottom"
Parameters
- key: K
- value: { bottom: number; left: number; right: number; top: number }[K]
Returns this

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
- keyPath: Iterable<unknown>
- value: unknown
Returns this

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: number; left: number; right: number; top: number }
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: number; left: number; right: number; top: number }
- bottom: number
  The bottom distance of the inset.
  Default
  0
- left: number
  The left distance of the inset. This is equivalent to x of a NutrientViewer.Geometry.Point.
  Default
  0
- right: number
  The right distance of the inset.
  Default
  0
- top: number
  The top distance of the inset. This is equivalent to y of a NutrientViewer.Geometry.Point.
  Default
  0

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 }
- bottom: number
  The bottom distance of the inset.
  Default
  0
- left: number
  The left distance of the inset. This is equivalent to x of a NutrientViewer.Geometry.Point.
  Default
  0
- right: number
  The right distance of the inset.
  Default
  0
- top: number
  The top distance of the inset. This is equivalent to y of a NutrientViewer.Geometry.Point.
  Default
  0

toSeq

toSeq(): Keyed<string, unknown>
Returns Keyed<string, unknown>

update

update<K extends "left" | "right" | "top" | "bottom">(
    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 "left" | "right" | "top" | "bottom"
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

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): this
Parameters
- keyPath: Iterable<unknown>
- notSetValue: unknown
- updater: (value: unknown) => unknown
Returns this
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
- keyPath: Iterable<unknown>
- updater: (value: unknown) => unknown
Returns this

withMutations

withMutations(mutator: (mutable: this) => unknown): 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) => unknown
Returns this
See
Map#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

Optionalbottom?: number

Default

Optionalleft?: number

Default

Optionalright?: number

Default

Optionaltop?: number

Default

Returns NutrientViewer.Geometry.Inset

Properties

Readonlybottom

Default

Readonlyleft

Default

Readonlyright

Default

Readonlytop

Default

Methods

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]

getIn

Parameters

Returns unknown

has

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

`Optional`bottom?: number

`Optional`left?: number

`Optional`right?: number

`Optional`top?: number

`Readonly`bottom

`Readonly`left

`Readonly`right

`Readonly`top

`Static`applyToRect

`Static`fromRect

`Static`fromValue