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 https://facebook.github.io/immutable-js/docs/#/Record|Immutable.Record and thus can be updated using set(key, value), for example: size.set("width", 20).

Example

Create and update a size.

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

Param: args

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

Default

{ width: 0, height: 0 }

Hierarchy

Record<{ height: number; width: number }, this> & Readonly<
{ height: number; width: number },
>
- Size

Index

Constructors

constructor

Properties

height width

Constructors

constructor

new Size(
    values?:
        | Iterable<[string, any]>
        | Partial<{ height: number; width: number }>,
): NutrientViewer.Geometry.Size
Parameters
- Optionalvalues: Iterable<[string, any]> | Partial<{ height: number; width: number }>
Returns NutrientViewer.Geometry.Size
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).constructor

Properties

`Readonly`height

height: number

The height of the size.

Default

`Readonly`width

width: number

The width of the size.

Default

Methods

[iterator]

"[iterator]"(): IterableIterator<["width" | "height", number]>
Returns IterableIterator<["width" | "height", number]>
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).[iterator]

apply

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

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).asMutable

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}
```

clear

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

Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).clear

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
- K extends "width" | "height"
Parameters
- key: K
Returns this
Alias
remove

Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).delete

deleteIn

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

Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).equals

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}
```

get

get<K extends "width" | "height">(
key: K,
notSetValue?: any,
): { 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
- K extends "width" | "height"
Parameters
- key: K
- OptionalnotSetValue: any
Returns { height: number; width: number }[K]
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).getIn

has

has(key: string): key is "width" | "height"
Parameters
- key: string
Returns key is "width" | "height"
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).has

hashCode

hashCode(): number
Returns number
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).hasIn

merge

merge(
    ...collections: (
        Iterable<[string, any]>
        | Partial<{ height: number; width: number }>
    )[],
): this
Parameters
- ...collections: (Iterable<[string, any]> | Partial<{ height: number; width: number }>)[]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).merge

mergeDeep

mergeDeep(
    ...collections: (
        Iterable<[string, any]>
        | Partial<{ height: number; width: number }>
    )[],
): this
Parameters
- ...collections: (Iterable<[string, any]> | Partial<{ height: number; width: number }>)[]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        Iterable<[string, any]>
        | Partial<{ height: number; width: number }>
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (Iterable<[string, any]> | Partial<{ height: number; width: number }>)[]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).mergeIn

mergeWith

mergeWith(
    merger: (oldVal: any, newVal: any, key: "width" | "height") => any,
    ...collections: (
        Iterable<[string, any]>
        | Partial<{ height: number; width: number }>
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: "width" | "height") => any
- ...collections: (Iterable<[string, any]> | Partial<{ height: number; width: number }>)[]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).mergeWith

remove

remove<K extends "width" | "height">(key: K): this
Type Parameters
- K extends "width" | "height"
Parameters
- key: K
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).removeIn

scale

scale(factor: number): NutrientViewer.Geometry.Size
Scales the width and height by a given factor.
Parameters
- factor: number
  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}
```

set

set<K extends "width" | "height">(
key: K,
value: { height: number; width: number }[K],
): this
Type Parameters
- K extends "width" | "height"
Parameters
- key: K
- value: { height: number; width: number }[K]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).setIn

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}
```

toJS

toJS(): { height: 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; width: any }
- height: any
  The height of the size.
  Default
  0
- width: any
  The width of the size.
  Default
  0
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).toJS

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
  0
- width: number
  The width of the size.
  Default
  0
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).toJSON

toObject

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

Returns { height: number; width: number }
- height: number
  The height of the size.
  Default
  0
- width: number
  The width of the size.
  Default
  0
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).toObject

toSeq

toSeq(): Keyed<"width" | "height", number>
Returns Keyed<"width" | "height", number>
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).toSeq

update

update<K extends "width" | "height">(
    key: K,
    updater: (
        value: { height: number; width: number }[K],
    ) => { height: number; width: number }[K],
): this
Type Parameters
- K extends "width" | "height"
Parameters
- key: K
- updater: (
  value: { height: number; width: number }[K],
  ) => { height: number; width: number }[K]
Returns this
Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 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<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from ImmutableRecord<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 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<{ /** * The `width` of the size. * * @default 0 */ width: number /** * The `height` of the size. * * @default 0 */ height: number }>({ width: 0, height: 0, }).withMutations

Class Size

Example

Param: args

Default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Geometry.Size

Properties

Readonlyheight

Default

Readonlywidth

Default

Methods

[iterator]

Returns IterableIterator<["width" | "height", number]>

apply

Parameters

Returns NutrientViewer.Geometry.Size

asImmutable

Returns this

See

asMutable

Returns this

See

ceil

Returns NutrientViewer.Geometry.Size

Example

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

floor

Returns NutrientViewer.Geometry.Size

Example

get

Type Parameters

Parameters

Returns { height: number; width: number }[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is "width" | "height"

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

`Readonly`height

`Readonly`width