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).

Class

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

Default Value

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

Hierarchy

Readonly__dangerousImmutableRecordFactoryInset

Constructors

new Inset(options)

Parameters
options{ bottom?: number; left?: number; right?: number; top?: number }
Optional
Inherited from Readonly<InsetData>.constructor

Properties

bottom

Readonly

number

The bottom distance of the inset.

Default Value

0

left

Readonly

number

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

Default Value

0

right

Readonly

number

The right distance of the inset.

Default Value

0

top

Readonly

number

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

Default Value

0

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
matrixTransformationMatrix
Returns
NutrientViewer.Geometry.Inset

setScale

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

Parameters
scalenumber
The scale to apply to the inset.

Returns
NutrientViewer.Geometry.Inset

applyToRect

Static

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
insetNutrientViewer.Geometry.Inset
An Inset instance.

rectNutrientViewer.Geometry.Rect
A Rect instance.

Returns
NutrientViewer.Geometry.Rect
A new Rect.
Example
const rect = NutrientViewer.Geometry.Inset.applyToRect( rectangleAnnotation.cloudyBorderInset, rectangleAnnotation.boundingBox );

fromRect

Static

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

fromValue

Static

fromValue(insetValue: number): NutrientViewer.Geometry.Inset
Returns a new inset using the provided vale for all properties.
Parameters
insetValuenumber
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, // }

Immutable Record API

asImmutable

Deprecated

asImmutable(): this
Deprecated
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Build the value once, or use withMutations().
See Also
Map#asImmutable

asMutable

Deprecated

asMutable(): this
Deprecated
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use withMutations().
See Also
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
Kextends "left" | "right" | "top" | "bottom"
Parameters
keyK
Returns
this

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Returns a new instance of this Record type with the value at the given key path removed.

Also available as removeIn.

Parameters
keyPathIterable<unknown>
Returns
this

equals

equals(other: unknown): boolean
Parameters
otherunknown
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
Kextends "left" | "right" | "top" | "bottom"
Parameters
keyK
Returns
{ bottom: number; left: number; right: number; top: number }[K]

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
keyPathIterable<unknown>
notSetValueunknown
Optional
Returns
unknown

has

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

merge

merge(
    ...collections: Partial<
        { bottom: number; left: number; right: number; top: number },
    >[],
): this
Parameters
...collectionsPartial<{ 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
keyPathIterable<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

Deprecated

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ bottom: number; left: number; right: number; top: number }>
    )[],
): this
Deprecated
Parameters
keyPathIterable<unknown>
...collections(
| Iterable<[string, unknown], any, any>
| Partial<{ bottom: number; left: number; right: number; top: number }>
)[]
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use update() followed by merge().

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

Deprecated

removeIn(keyPath: Iterable<unknown>): this
Deprecated
Parameters
keyPathIterable<unknown>
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use deleteIn(), or update() followed by delete().

set

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

setIn

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

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 Value
0
left: number
The left distance of the inset. This is equivalent to x of a NutrientViewer.Geometry.Point.

Default Value
0
right: number
The right distance of the inset.

Default Value
0
top: number
The top distance of the inset. This is equivalent to y of a NutrientViewer.Geometry.Point.

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

Default Value
0
right: number
The right distance of the inset.

Default Value
0
top: number
The top distance of the inset. This is equivalent to y of a NutrientViewer.Geometry.Point.

Default Value
0

toSeq

Deprecated

toSeq(): Keyed<string, unknown>
Deprecated
Returns
Keyed<string, unknown>
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use entries().

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
Kextends "left" | "right" | "top" | "bottom"
Parameters
keyK
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
keyPathIterable<unknown>
notSetValueunknown
updater(value: unknown) => unknown
Returns
this
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<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 Also
Map#withMutations

Class Inset

Example

Default Value

Hierarchy

Constructors

Parameters

Properties

Default Value

Default Value

Default Value

Default Value

Methods

Parameters

Returns

Parameters

Returns

Parameters

Returns

Example

Parameters

Returns

Parameters

Returns

Example

Immutable Record API

Returns

Deprecated

See Also

Returns

Deprecated

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

bottom: number

Default Value

left: number

Default Value

right: number

Default Value

top: number

Default Value

Returns

bottom: number

Default Value

left: number