Class Size

A size is a 2D vector that describes the size of an element. It has the values 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 Immutable.Record and thus can be updated using set(key, value), for example: size.set("width", 20).

Class

Example

Create and update a size.

const size = new NutrientViewer.Geometry.Size({ width: 200, height: 100 });
size = size.set("height", 200);
size.height; // => 200

Default Value

{ width: 0, height: 0 }

Hierarchy

Readonly__dangerousImmutableRecordFactorySize

Constructors

new Size(options)

Parameters
options{ height?: number; width?: number }
Optional
Inherited from Readonly<SizeData>.constructor

Properties

height

Readonly

number

The height of the size.

Default Value

0

width

Readonly

number

The width of the size.

Default Value

0

Methods

apply

apply(matrix: TransformationMatrix): NutrientViewer.Geometry.Size
Applies a transformation to the point by scaling to the dimension [width, height]

Parameters
matrixTransformationMatrix
Returns
NutrientViewer.Geometry.Size

ceil

ceil(): NutrientViewer.Geometry.Size
Returns a new size with width and height rounded to a number which is greater than or equal to the current value.
Returns
NutrientViewer.Geometry.Size
A new Size.
Example
var size = new NutrientViewer.Geometry.Size({ width: 20.5, height: 30.1 }); size.ceil(); // => Size {width: 21, height: 31}

floor

floor(): NutrientViewer.Geometry.Size
Returns a new size with width and height rounded to a number which is smaller than or equal to the current value.
Returns
NutrientViewer.Geometry.Size
A new Size.
Example
var size = new NutrientViewer.Geometry.Size({ width: 20.5, height: 30.1 }); size.floor(); // => Size {width: 20, height: 30}

scale

scale(factor: number): NutrientViewer.Geometry.Size
Scales the width and height by a given factor.
Parameters
factornumber
The scale factor.

Returns
NutrientViewer.Geometry.Size
A new Size.
Example
var size = new NutrientViewer.Geometry.Size({ width: 20, height: 30 }); size.scale(2); // => Size {width: 40, height: 60}

swapDimensions

swapDimensions(): NutrientViewer.Geometry.Size
Returns a new size with the width set to the current height value and the height set to the current width value.
Returns
NutrientViewer.Geometry.Size
A new Size.
Example
var size = new NutrientViewer.Geometry.Size({ width: 20.5, height: 30.1 }); size.swapDimensions(); // => Size {width: 30.1, height: 20.5}

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 "width" | "height">(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 "width" | "height"
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 "width" | "height">(key: K): { height: 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
Kextends "width" | "height"
Parameters
keyK
Returns
{ height: number; width: 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<{ height: number; width: number }>[]): this
Parameters
...collectionsPartial<{ height: number; width: number }>[]
Returns
this

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ height: number; width: number }>
    )[],
): this
Parameters
...collections(
| Iterable<[string, unknown], any, any>
| Partial<{ height: number; width: number }>
)[]
Returns
this

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ height: number; width: number }>
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections(
| Iterable<[string, unknown], any, any>
| Partial<{ height: number; width: number }>
)[]
Returns
this

mergeDeepWith

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

mergeIn

Deprecated

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<{ height: number; width: number }>
    )[],
): this
Deprecated
Parameters
keyPathIterable<unknown>
...collections(
| Iterable<[string, unknown], any, any>
| Partial<{ height: number; width: 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<{ height: number; width: number }>
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections(
| Iterable<[string, unknown], any, any>
| Partial<{ height: number; width: 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 "width" | "height">(
key: K,
value: { height: number; width: number }[K],
): this
Type Parameters
Kextends "width" | "height"
Parameters
keyK
value{ height: number; width: number }[K]
Returns
this

setIn

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

toJS

toJS(): { height: number; width: 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
{ height: number; width: number }
height: number
The height of the size.

Default Value
0
width: number
The width of the size.

Default Value
0

toJSON

toJSON(): { height: number; width: number }
Shallowly converts this Record to equivalent native JavaScript Object.
Returns
{ height: number; width: number }
height: number
The height of the size.

Default Value
0
width: number
The width of the size.

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 "width" | "height">(
    key: K,
    updater: (
        value: { height: number; width: number }[K],
    ) => { height: number; width: number }[K],
): this
Type Parameters
Kextends "width" | "height"
Parameters
keyK
updater(
value: { height: number; width: number }[K]
) => { height: number; width: 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 Size

Example

Default Value

Hierarchy

Constructors

Parameters

Properties

Default Value

Default Value

Methods

Parameters

Returns

Returns

Example

Returns

Example

Parameters

Returns

Example

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

height: number

Default Value

width: number

Default Value

Returns

height: number

Default Value

width: number

Default Value

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters