Class Point

A point describes a 2D vector in space consisting of an x and y coordinate. 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: point.set("x", 20).

Example

Create and update a point.

const point = new NutrientViewer.Geometry.Point({ x: 20, y: 30 });
point = point.set("y", 20);
point.y; // => 20

Param: args

An object used to initialize the Point. If x or y is omitted, 0 will be used instead.

Default

{ x: 0, y: 0 }

Hierarchy

Record<{ x?: number; y?: number; [k: string]: unknown }, this> & Readonly<
{ x?: number; y?: number; [k: string]: unknown },
>
- Point
  - NutrientViewer.Geometry.DrawingPoint

Indexable

readonly [key: string]: unknown

Index

Constructors

constructor

new Point(
options?: { x?: number; y?: number; [k: string]: unknown },
): NutrientViewer.Geometry.Point
Parameters
- Optionaloptions: { x?: number; y?: number; [k: string]: unknown }
Returns NutrientViewer.Geometry.Point
Overrides (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).constructor

Properties

x

x: number

The x coordinate of the point.

Default

y

y: number

The y coordinate of the point.

Default

`Static`defaultValues

defaultValues: IObject = ...

Methods

[iterator]

"[iterator]"(): IterableIterator<
[keyof { x?: number; y?: number; [k: string]: unknown }, unknown],
>
Returns IterableIterator<
[keyof { x?: number; y?: number; [k: string]: unknown }, unknown],
>
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).[iterator]

apply

apply(matrix: TransformationMatrix): this
Applies a transformation to the point by multiplying the point like a 2D vector to the matrix.
Parameters
- matrix: TransformationMatrix
Returns this

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).asMutable

clear

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

Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).clear

delete

delete<K extends keyof { x?: number; y?: number; [k: string]: unknown }>(
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 { x?: number; y?: number; [k: string]: unknown }
Parameters
- key: K
Returns this
Alias
remove

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).delete

deleteIn

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

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).deleteIn

distance

distance(other: this): number
Calculates the euclidean distance to another point.
Parameters
- other: this
  The other point to calculate the distance with.
Returns number
The distance between the two points.
Example
```
var point1 = new NutrientViewer.Geometry.Point({ x: 10, y: 10 });
var point2 = new NutrientViewer.Geometry.Point({ x: 20, y: 10 });
point1.distance(point2); // => 10
```

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).equals

get

get<K extends keyof { x?: number; y?: number; [k: string]: unknown }>(
key: K,
notSetValue?: any,
): { x?: number; y?: number; [k: string]: unknown }[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 { x?: number; y?: number; [k: string]: unknown }
Parameters
- key: K
- OptionalnotSetValue: any
Returns { x?: number; y?: number; [k: string]: unknown }[K]
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).getIn

has

has(key: string): key is string
Parameters
- key: string
Returns key is string
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).has

hashCode

hashCode(): number
Returns number
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).hashCode

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).hasIn

merge

merge(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ x?: number; y?: number; [k: string]: unknown }>
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ x?: number; y?: number; [k: string]: unknown }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ x?: number; y?: number; [k: string]: unknown }>
    )[],
): this
Parameters
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ x?: number; y?: number; [k: string]: unknown }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ x?: number; y?: number; [k: string]: unknown }>
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ x?: number; y?: number; [k: string]: unknown }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: any,
        newVal: any,
        key: keyof { x?: number; y?: number; [k: string]: unknown },
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<{ x?: number; y?: number; [k: string]: unknown }>
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: keyof { x?: number; y?: number; [k: string]: unknown },
  ) => any
- ...collections: (
  | Iterable<[string, any]>
  | Partial<{ x?: number; y?: number; [k: string]: unknown }>
  )[]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).mergeWith

remove

remove<K extends keyof { x?: number; y?: number; [k: string]: unknown }>(
key: K,
): this
Type Parameters
- K extends keyof { x?: number; y?: number; [k: string]: unknown }
Parameters
- key: K
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).remove

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).removeIn

rotate

rotate(deg: number): this
Rotates the point at the origin [0, 0].
Parameters
- deg: number
Returns this

scale

scale(sx: number, sy?: number): this
Scales x and y by the given sx and sy factor. If only sx is set and sy not defined, it will scale x and y by sx.
Parameters
- sx: number
  Scale value for the x coordinate. If sy is not set, this scale will also be applied to y.
- Optionalsy: number
  If empty, it will scale y with sx as well.
Returns this
A new Point.
Example
```
const point = new NutrientViewer.Geometry.Point({ x: 10, y: 10 });
point.scale(2); // => Point {x: 20, y: 20}
```

set

set<K extends keyof { x?: number; y?: number; [k: string]: unknown }>(
key: K,
value: { x?: number; y?: number; [k: string]: unknown }[K],
): this
Type Parameters
- K extends keyof { x?: number; y?: number; [k: string]: unknown }
Parameters
- key: K
- value: { x?: number; y?: number; [k: string]: unknown }[K]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).set

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).setIn

toJS

toJS(): { x?: any; y?: any; [key: string]: 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 { x?: any; y?: any; [key: string]: any }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).toJS

toJSON

toJSON(): { x?: number; y?: number; [k: string]: unknown }
Shallowly converts this Record to equivalent native JavaScript Object.

Returns { x?: number; y?: number; [k: string]: unknown }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).toJSON

toObject

toObject(): { x?: number; y?: number; [k: string]: unknown }
Shallowly converts this Record to equivalent JavaScript Object.

Returns { x?: number; y?: number; [k: string]: unknown }
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).toObject

toSeq

toSeq(): Keyed<keyof { x?: number; y?: number; [k: string]: unknown }, unknown>
Returns Keyed<keyof { x?: number; y?: number; [k: string]: unknown }, unknown>
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).toSeq

translate

translate(point: { x: number; y: number }): this
Translate all values of the point by a given Point.
Parameters
- point: { x: number; y: number }
  A point that describes the translation distance.
Returns this
A new Point.
Example
```
const point = new NutrientViewer.Geometry.Point({ x: 10, y: 10 });
point.translate(new NutrientViewer.Geometry.Point({ x: 5, y: -5 })); // => Point {x: 15, y: 5}
```

translateX

translateX(tx: number): this
Translate the x value by a given number.
Parameters
- tx: number
  A number to translate the x value.
Returns this
A new Point.
Example
```
const point = new NutrientViewer.Geometry.Point({ x: 10, y: 10 });
point.translateX(5); // => Point {x: 15, y: 10}
```

translateY

translateY(ty: number): this
Translate the y value by a given number.
Parameters
- ty: number
  A number to translate the y value.
Returns this
A new Point.
Example
```
const point = new NutrientViewer.Geometry.Point({ x: 10, y: 10 });
point.translateY(5); // => Point {x: 10, y: 15}
```

update

update<K extends keyof { x?: number; y?: number; [k: string]: unknown }>(
    key: K,
    updater: (
        value: { x?: number; y?: number; [k: string]: unknown }[K],
    ) => { x?: number; y?: number; [k: string]: unknown }[K],
): this
Type Parameters
- K extends keyof { x?: number; y?: number; [k: string]: unknown }
Parameters
- key: K
- updater: (
  value: { x?: number; y?: number; [k: string]: unknown }[K],
  ) => { x?: number; y?: number; [k: string]: unknown }[K]
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).update

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).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 (InheritableImmutableRecord as unknown as ImmutableRecord.Factory<PointCtorProps>).withMutations

Class Point

Example

Param: args

Default

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Geometry.Point

Properties

x

Default

y

Default

StaticdefaultValues

Methods

[iterator]

Returns IterableIterator< [keyof { x?: number; y?: number; [k: string]: unknown }, unknown],>

apply

Parameters

Returns this

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

distance

Parameters

Returns number

Example

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { x?: number; y?: number; [k: string]: unknown }[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is string

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

`Static`defaultValues

Returns IterableIterator<
[keyof { x?: number; y?: number; [k: string]: unknown }, unknown],
>