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.

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

See

Hierarchy

Record<
    {
        disableAutoZoom?: boolean;
        id: null
        | string;
        node: null | Node;
        noRotate?: boolean;
        onAppear?: null | ((...args: unknown[]) => void);
        onDisappear?: null | ((...args: unknown[]) => void);
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
    this,
> & Readonly<
    {
        disableAutoZoom?: boolean;
        id: null
        | string;
        node: null | Node;
        noRotate?: boolean;
        onAppear?: null | ((...args: unknown[]) => void);
        onDisappear?: null | ((...args: unknown[]) => void);
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
>
- CustomOverlayItem

Index

Constructors

constructor

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

Properties

disableAutoZoom

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

false

id

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: Node

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

noRotate

noRotate: boolean

Whether the node should not be rotated with the page.

`Optional`onAppear

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

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

`Optional`onDisappear

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

Optional callback to invoke when the custom item is removed.

pageIndex

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

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.

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
        | undefined
        | null
        | string
        | number
        | boolean
        | Node
        | NutrientViewer.Geometry.Point
        | ((...args: unknown[]) => void)
        | ((...args: unknown[]) => void),
    ],
>
Returns IterableIterator<
    [
        keyof {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
        | undefined
        | null
        | string
        | number
        | boolean
        | Node
        | NutrientViewer.Geometry.Point
        | ((...args: unknown[]) => void)
        | ((...args: unknown[]) => void),
    ],
>
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
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
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 {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            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 {
      disableAutoZoom?: boolean;
      id: null | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      pageIndex: number;
      position: NutrientViewer.Geometry.Point;
  }
Parameters
- key: K
Returns this
Alias
remove

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<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

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: any): boolean
Parameters
- other: any
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 {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
    notSetValue?: any,
): {
    disableAutoZoom?: boolean;
    id: null | string;
    node: null | Node;
    noRotate?: boolean;
    onAppear?: null | ((...args: unknown[]) => void);
    onDisappear?: null | ((...args: unknown[]) => void);
    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 {
      disableAutoZoom?: boolean;
      id: null | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      pageIndex: number;
      position: NutrientViewer.Geometry.Point;
  }
Parameters
- key: K
- OptionalnotSetValue: any
Returns {
    disableAutoZoom?: boolean;
    id: null | string;
    node: null | Node;
    noRotate?: boolean;
    onAppear?: null | ((...args: unknown[]) => void);
    onDisappear?: null | ((...args: unknown[]) => void);
    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
- key: string
- notSetValue: T
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<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
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
- key: string
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<any>): boolean
Parameters
- keyPath: Iterable<any>
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, any]>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: null
                | string;
                node: null | Node;
                noRotate?: boolean;
                onAppear?: null | ((...args: unknown[]) => void);
                onDisappear?: null | ((...args: unknown[]) => void);
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              disableAutoZoom?: boolean;
              id: null
              | string;
              node: null | Node;
              noRotate?: boolean;
              onAppear?: null | ((...args: unknown[]) => void);
              onDisappear?: null | ((...args: unknown[]) => void);
              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, any]>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: null
                | string;
                node: null | Node;
                noRotate?: boolean;
                onAppear?: null | ((...args: unknown[]) => void);
                onDisappear?: null | ((...args: unknown[]) => void);
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              disableAutoZoom?: boolean;
              id: null
              | string;
              node: null | Node;
              noRotate?: boolean;
              onAppear?: null | ((...args: unknown[]) => void);
              onDisappear?: null | ((...args: unknown[]) => void);
              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<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
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: any, newVal: any, key: any) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: null
                | string;
                node: null | Node;
                noRotate?: boolean;
                onAppear?: null | ((...args: unknown[]) => void);
                onDisappear?: null | ((...args: unknown[]) => void);
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
- merger: (oldVal: any, newVal: any, key: any) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              disableAutoZoom?: boolean;
              id: null
              | string;
              node: null | Node;
              noRotate?: boolean;
              onAppear?: null | ((...args: unknown[]) => void);
              onDisappear?: null | ((...args: unknown[]) => void);
              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<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
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: any,
        newVal: any,
        key: keyof {
            disableAutoZoom?: boolean;
            id: null | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
    ) => any,
    ...collections: (
        | Iterable<[string, any]>
        | Partial<
            {
                disableAutoZoom?: boolean;
                id: null
                | string;
                node: null | Node;
                noRotate?: boolean;
                onAppear?: null | ((...args: unknown[]) => void);
                onDisappear?: null | ((...args: unknown[]) => void);
                pageIndex: number;
                position: NutrientViewer.Geometry.Point;
            },
        >
    )[],
): this
Parameters
- merger: (
      oldVal: any,
      newVal: any,
      key: keyof {
          disableAutoZoom?: boolean;
          id: null | string;
          node: null | Node;
          noRotate?: boolean;
          onAppear?: null | ((...args: unknown[]) => void);
          onDisappear?: null | ((...args: unknown[]) => void);
          pageIndex: number;
          position: NutrientViewer.Geometry.Point;
      },
  ) => any
- ...collections: (
      | Iterable<[string, any]>
      | Partial<
          {
              disableAutoZoom?: boolean;
              id: null
              | string;
              node: null | Node;
              noRotate?: boolean;
              onAppear?: null | ((...args: unknown[]) => void);
              onDisappear?: null | ((...args: unknown[]) => void);
              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 {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
): this
Type Parameters
- K extends keyof {
      disableAutoZoom?: boolean;
      id: null | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      pageIndex: number;
      position: NutrientViewer.Geometry.Point;
  }
Parameters
- key: K
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<any>): this
Parameters
- keyPath: Iterable<any>
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 {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
    value: {
        disableAutoZoom?: boolean;
        id: null | string;
        node: null | Node;
        noRotate?: boolean;
        onAppear?: null | ((...args: unknown[]) => void);
        onDisappear?: null | ((...args: unknown[]) => void);
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    }[K],
): this
Type Parameters
- K extends keyof {
      disableAutoZoom?: boolean;
      id: null | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      pageIndex: number;
      position: NutrientViewer.Geometry.Point;
  }
Parameters
- key: K
- value: {
      disableAutoZoom?: boolean;
      id: null | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      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<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
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(): {
    disableAutoZoom?: any;
    id: any;
    node: any;
    noRotate?: any;
    onAppear?: any;
    onDisappear?: any;
    pageIndex: any;
    position: 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 {
    disableAutoZoom?: any;
    id: any;
    node: any;
    noRotate?: any;
    onAppear?: any;
    onDisappear?: any;
    pageIndex: any;
    position: any;
}
Inherited from ImmutableRecord<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).toJS

toJSON

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

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

Returns {
    disableAutoZoom?: boolean;
    id: null | string;
    node: null | Node;
    noRotate?: boolean;
    onAppear?: null | ((...args: unknown[]) => void);
    onDisappear?: null | ((...args: unknown[]) => void);
    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 {
        disableAutoZoom?: boolean;
        id: null
        | string;
        node: null | Node;
        noRotate?: boolean;
        onAppear?: null | ((...args: unknown[]) => void);
        onDisappear?: null | ((...args: unknown[]) => void);
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
    | undefined
    | null
    | string
    | number
    | boolean
    | Node
    | NutrientViewer.Geometry.Point
    | ((...args: unknown[]) => void)
    | ((...args: unknown[]) => void),
>
Returns Keyed<
    keyof {
        disableAutoZoom?: boolean;
        id: null
        | string;
        node: null | Node;
        noRotate?: boolean;
        onAppear?: null | ((...args: unknown[]) => void);
        onDisappear?: null | ((...args: unknown[]) => void);
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    },
    | undefined
    | null
    | string
    | number
    | boolean
    | Node
    | NutrientViewer.Geometry.Point
    | ((...args: unknown[]) => void)
    | ((...args: unknown[]) => void),
>
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 {
            disableAutoZoom?: boolean;
            id: null
            | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        },
>(
    key: K,
    updater: (
        value: {
            disableAutoZoom?: boolean;
            id: null | string;
            node: null | Node;
            noRotate?: boolean;
            onAppear?: null | ((...args: unknown[]) => void);
            onDisappear?: null | ((...args: unknown[]) => void);
            pageIndex: number;
            position: NutrientViewer.Geometry.Point;
        }[K],
    ) => {
        disableAutoZoom?: boolean;
        id: null
        | string;
        node: null | Node;
        noRotate?: boolean;
        onAppear?: null | ((...args: unknown[]) => void);
        onDisappear?: null | ((...args: unknown[]) => void);
        pageIndex: number;
        position: NutrientViewer.Geometry.Point;
    }[K],
): this
Type Parameters
- K extends keyof {
      disableAutoZoom?: boolean;
      id: null | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      pageIndex: number;
      position: NutrientViewer.Geometry.Point;
  }
Parameters
- key: K
- updater: (
      value: {
          disableAutoZoom?: boolean;
          id: null | string;
          node: null | Node;
          noRotate?: boolean;
          onAppear?: null | ((...args: unknown[]) => void);
          onDisappear?: null | ((...args: unknown[]) => void);
          pageIndex: number;
          position: NutrientViewer.Geometry.Point;
      }[K],
  ) => {
      disableAutoZoom?: boolean;
      id: null
      | string;
      node: null | Node;
      noRotate?: boolean;
      onAppear?: null | ((...args: unknown[]) => void);
      onDisappear?: null | ((...args: unknown[]) => void);
      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<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
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
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) => 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<ICustomOverlayItem>({ disableAutoZoom: false, id: null, node: null, noRotate: false, pageIndex: 0, position: new Point(), onAppear: null, onDisappear: null, }).withMutations

Class CustomOverlayItem

Example

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.CustomOverlayItem

Properties

disableAutoZoom

Default

id

node

noRotate

OptionalonAppear

OptionalonDisappear

pageIndex

position

Methods

[iterator]

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { disableAutoZoom?: boolean; id: null | string; node: null | Node; noRotate?: boolean; onAppear?: null | ((...args: unknown[]) => void); onDisappear?: null | ((...args: unknown[]) => void); pageIndex: number; position: NutrientViewer.Geometry.Point;}[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is | "id" | "pageIndex" | "noRotate" | "disableAutoZoom" | "node" | "position" | "onAppear" | "onDisappear"

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

`Optional`onAppear

`Optional`onDisappear

Returns {
disableAutoZoom?: boolean;
id: null | string;
node: null | Node;
noRotate?: boolean;
onAppear?: null | ((...args: unknown[]) => void);
onDisappear?: null | ((...args: unknown[]) => void);
pageIndex: number;
position: NutrientViewer.Geometry.Point;
}[K]

Returns key is
| "id"
| "pageIndex"
| "noRotate"
| "disableAutoZoom"
| "node"
| "position"
| "onAppear"
| "onDisappear"

Returns {
disableAutoZoom?: any;
id: any;
node: any;
noRotate?: any;
onAppear?: any;
onDisappear?: any;
pageIndex: any;
position: any;
}

Returns {
disableAutoZoom?: boolean;
id: null | string;
node: null | Node;
noRotate?: boolean;
onAppear?: null | ((...args: unknown[]) => void);
onDisappear?: null | ((...args: unknown[]) => void);
pageIndex: number;
position: NutrientViewer.Geometry.Point;
}

Returns {
disableAutoZoom?: boolean;
id: null | string;
node: null | Node;
noRotate?: boolean;
onAppear?: null | ((...args: unknown[]) => void);
onDisappear?: null | ((...args: unknown[]) => void);
pageIndex: number;
position: NutrientViewer.Geometry.Point;
}