Reference NutrientViewerCustomOverlayItem

Class CustomOverlayItem

This record is used to persist the information for a Custom Overlay Item.

Custom Overlay Items are user defined DOM Nodes that are rendered in a page at a given position.

Class

Example

Creating an image and rendering it as Custom Overlay Item.

let img = document.createElement("img");
img.src = "https://example.com/logo.png";

const item = new NutrientViewer.CustomOverlayItem({
  id: "logo-item",
  node: img,
  pageIndex: 0,
  position: new NutrientViewer.Geometry.Point({ x: 100, y: 100 }),
  onAppear() {
    console.log('rendered!');
  }
});

instance.setCustomOverlayItem(item);

Hierarchy

RecordCustomOverlayItem

Constructors

new CustomOverlayItem(args)

Parameters
args
{ … }{
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Overrides ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).constructor

Properties

disableAutoZoom

boolean

Whether the node should not be zoomed (scaled) with the page.

Custom zoom handling makes sense when you want to display rasterized images for example, and you need to manually re-render them (maybe when using <canvas> images or want to display images at different resolutions).

To track zoom changes and manually update overlay items you can subscribe to the viewState.zoom.change event.

By default items will zoom with the page using a CSS based scale transformation.

Default Value

false

id

string

A unique identifier to describe the custom overlay item. New IDs should be generated by the user and should be unique.

node

Node

A reference to the DOM Node to render in the page.

noRotate

boolean

Whether the node should not be rotated with the page.

onAppear

Optional

((...args: unknown[]) => void) | null

Optional callback to invoke when the custom item is created and appears in the viewport.

onDisappear

Optional

((...args: unknown[]) => void) | null

Optional callback to invoke when the custom item is removed.

pageIndex

number

The page index on which the custom item is placed. It's important to notice that a custom item can only ever be on one page.

position

NutrientViewer.Geometry.Point

Position of this custom item in the page. The coordinates are in the PDF page space with the origin being on the top left.

Immutable Record API

displayName

Static

string

The name provided to Record(values, name) can be accessed with displayName.

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof { … },
        | string
        | number
        | boolean
        | Node
        | NutrientViewer.Geometry.Point
        | ((...args: unknown[]) => void)
        | ((...args: unknown[]) => void)
        | null
        | undefined,
    ],
>"[iterator]"(): IterableIterator<
    [
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
        | string
        | number
        | boolean
        | Node
        | NutrientViewer.Geometry.Point
        | ((...args: unknown[]) => void)
        | ((...args: unknown[]) => void)
        | null
        | undefined,
    ],
>
Returns
IterableIterator<
[
keyof { … },
| string
| number
| boolean
| Node
| NutrientViewer.Geometry.Point
| ((...args: unknown[]) => void)
| ((...args: unknown[]) => void)
| null
| undefined
]
>IterableIterator<
    [
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
        | string
        | number
        | boolean
        | Node
        | NutrientViewer.Geometry.Point
        | ((...args: unknown[]) => void)
        | ((...args: unknown[]) => void)
        | null
        | undefined,
    ],
>
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).asMutable

clear

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

Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    K extends
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    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 { … }extends keyof {
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).equals

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
    K extends
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}[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 { … }extends keyof {
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}[K]
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).getIn

has

has(
    key: string,
): key is
    | "id"
    | "pageIndex"
    | "noRotate"
    | "disableAutoZoom"
    | "node"
    | "position"
    | "onAppear"
    | "onDisappear"
Parameters
keystring
Returns
key is
| "id"
| "pageIndex"
| "noRotate"
| "disableAutoZoom"
| "node"
| "position"
| "onAppear"
| "onDisappear"
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).has

hashCode

hashCode(): number
Returns
number
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: string
                | null;
                node: Node | null;
                noRotate?: boolean;
                onAppear?: ((...args: unknown[]) => void) | null;
                onDisappear?: ((...args: unknown[]) => void) | null;
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: string
                | null;
                node: Node | null;
                noRotate?: boolean;
                onAppear?: ((...args: unknown[]) => void) | null;
                onDisappear?: ((...args: unknown[]) => void) | null;
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: string
                | null;
                node: Node | null;
                noRotate?: boolean;
                onAppear?: ((...args: unknown[]) => void) | null;
                onDisappear?: ((...args: unknown[]) => void) | null;
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).mergeIn

mergeWith

mergeWith(
    merger: (oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: keyof {
            disableAutoZoom?: boolean;
            id: string | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: string
                | null;
                node: Node | null;
                noRotate?: boolean;
                onAppear?: ((...args: unknown[]) => void) | null;
                onDisappear?: ((...args: unknown[]) => void) | null;
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
merger
(oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown(
    oldVal: unknown,
    newVal: unknown,
    key: keyof {
        disableAutoZoom?: boolean;
        id: string | null;
        node: Node | null;
        noRotate?: boolean;
        onAppear?: ((...args: unknown[]) => void) | null;
        onDisappear?: ((...args: unknown[]) => void) | null;
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
    K extends
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
): this
Type Parameters
K
extends keyof { … }extends keyof {
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    K extends
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
    value: {
        disableAutoZoom?: boolean;
        id: string | null;
        node: Node | null;
        noRotate?: boolean;
        onAppear?: ((...args: unknown[]) => void) | null;
        onDisappear?: ((...args: unknown[]) => void) | null;
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Parameters
keyK
value
{ … }[K]{
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}[K]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).setIn

toJS

toJS(): { … }toJS(): {
    disableAutoZoom?: boolean;
    id: string
    | null;
    node: unknown;
    noRotate?: boolean;
    onAppear?: unknown;
    onDisappear?: unknown;
    pageIndex: number;
    position: unknown;
}
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
{ … }{
    disableAutoZoom?: boolean;
    id: string | null;
    node: unknown;
    noRotate?: boolean;
    onAppear?: unknown;
    onDisappear?: unknown;
    pageIndex: number;
    position: unknown;
}
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).toJS

toJSON

toJSON(): { … }toJSON(): {
    disableAutoZoom?: boolean;
    id: string
    | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).toJSON

toObject

toObject(): { … }toObject(): {
    disableAutoZoom?: boolean;
    id: string
    | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns
{ … }{
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).toObject

toSeq

toSeq(): Keyed<
    keyof { … },
    | string
    | number
    | boolean
    | Node
    | NutrientViewer.Geometry.Point
    | ((...args: unknown[]) => void)
    | ((...args: unknown[]) => void)
    | null
    | undefined,
>toSeq(): Keyed<
    keyof {
        disableAutoZoom?: boolean;
        id: string
        | null;
        node: Node | null;
        noRotate?: boolean;
        onAppear?: ((...args: unknown[]) => void) | null;
        onDisappear?: ((...args: unknown[]) => void) | null;
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
    | string
    | number
    | boolean
    | Node
    | NutrientViewer.Geometry.Point
    | ((...args: unknown[]) => void)
    | ((...args: unknown[]) => void)
    | null
    | undefined,
>
Returns
Keyed<
keyof { … },
| string
| number
| boolean
| Node
| NutrientViewer.Geometry.Point
| ((...args: unknown[]) => void)
| ((...args: unknown[]) => void)
| null
| undefined
>Keyed<
    keyof {
        disableAutoZoom?: boolean;
        id: string
        | null;
        node: Node | null;
        noRotate?: boolean;
        onAppear?: ((...args: unknown[]) => void) | null;
        onDisappear?: ((...args: unknown[]) => void) | null;
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
    | string
    | number
    | boolean
    | Node
    | NutrientViewer.Geometry.Point
    | ((...args: unknown[]) => void)
    | ((...args: unknown[]) => void)
    | null
    | undefined,
>
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).toSeq

update

update<K extends keyof { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            disableAutoZoom?: boolean;
            id: string
            | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
    updater: (
        value: {
            disableAutoZoom?: boolean;
            id: string | null;
            node: Node | null;
            noRotate?: boolean;
            onAppear?: ((...args: unknown[]) => void) | null;
            onDisappear?: ((...args: unknown[]) => void) | null;
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        }[K],
    ) => {
        disableAutoZoom?: boolean;
        id: string
        | null;
        node: Node | null;
        noRotate?: boolean;
        onAppear?: ((...args: unknown[]) => void) | null;
        onDisappear?: ((...args: unknown[]) => void) | null;
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    disableAutoZoom?: boolean;
    id: string | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        disableAutoZoom?: boolean;
        id: string | null;
        node: Node | null;
        noRotate?: boolean;
        onAppear?: ((...args: unknown[]) => void) | null;
        onDisappear?: ((...args: unknown[]) => void) | null;
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    }[K],
) => {
    disableAutoZoom?: boolean;
    id: string
    | null;
    node: Node | null;
    noRotate?: boolean;
    onAppear?: ((...args: unknown[]) => void) | null;
    onDisappear?: ((...args: unknown[]) => void) | null;
    pageIndex: number;
    position: NutrientViewer.Geometry.Point;
}[K]
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).updateIn

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).wasAltered

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
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).withMutations

Class CustomOverlayItem

Example

See Also

Hierarchy

Constructors

Parameters

Properties

Default Value

Immutable Record API

Returns

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

See Also

Parameters

Returns

See Also