Class Bookmark

This record is used to persist the information for a bookmark.

A bookmark is an object that registers a PDF action, usually triggered to go to a page.

Example

Creating a bookmark for the 3rd page of a document.

const bookmark = new NutrientViewer.Bookmark({
  name: 'test bookmark',
  action: new NutrientViewer.Actions.GoToAction({ pageIndex: 3 })
});
instance.create(bookmark);

See

Hierarchy

Record<
    {
        action: NutrientViewer.Actions.Action
        | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    },
    this,
> & Readonly<
    {
        action: NutrientViewer.Actions.Action
        | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    },
>
- Bookmark

Properties

action

action: NutrientViewer.Actions.Action

The action that will be triggered when the bookmark is either clicked or tapped.

Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.

id

id: string

A unique identifier to describe the bookmark. When a bookmark is created in the UI, the viewer has to generate a unique ID.

When changes are saved to the underlying bookmark provider, we call Instance#ensureChangesSaved to make sure the annotation has been persisted from the provider.

`Readonly`name

name: string | null

optional

An optional name to associate to the bookmark.

Default

null

`Readonly`pdfBookmarkId

pdfBookmarkId: string | null

When the bookmark is extracted directly from a PDF file, the pdfBookmarkId refers to the identifier that was used in the PDF document.

This ID is optional since newly created bookmarks using the SYNCProvider annotation provider won't have a pdfBookmarkId assigned.

Default

null

`Static`displayName

displayName: string

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

`Static`toSerializableObject

toSerializableObject: (bookmark: NutrientViewer.Bookmark) => BookmarkJSON = toJSON

Bookmark serializer. Converts a bookmark to InstantJSON compliant objects.

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
        string
        | number
        | NutrientViewer.Actions.Action
        | null,
    ],
>
Returns IterableIterator<
    [
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
        string
        | number
        | NutrientViewer.Actions.Action
        | null,
    ],
>
Inherited from Immutable.Record<BookmarkProps>(defaultValues).[iterator]

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from Immutable.Record<BookmarkProps>(defaultValues).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from Immutable.Record<BookmarkProps>(defaultValues).asMutable

clear

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

Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).clear

delete

delete<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
>(
    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 {
      action: NutrientViewer.Actions.Action | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }
Parameters
- key: K
Returns this
Alias
remove

Inherited from Immutable.Record<BookmarkProps>(defaultValues).delete

deleteIn

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

Inherited from Immutable.Record<BookmarkProps>(defaultValues).deleteIn

equals

equals(other: unknown): boolean
Parameters
- other: unknown
Returns boolean
Inherited from Immutable.Record<BookmarkProps>(defaultValues).equals

get

get<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}[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 {
      action: NutrientViewer.Actions.Action | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }
Parameters
- key: K
- OptionalnotSetValue: unknown
Returns {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}[K]
Inherited from Immutable.Record<BookmarkProps>(defaultValues).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from Immutable.Record<BookmarkProps>(defaultValues).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
- keyPath: Iterable<unknown>
Returns unknown
Inherited from Immutable.Record<BookmarkProps>(defaultValues).getIn

has

has(key: string): key is "id" | "name" | "action" | "pdfBookmarkId" | "sortKey"
Parameters
- key: string
Returns key is "id" | "name" | "action" | "pdfBookmarkId" | "sortKey"
Inherited from Immutable.Record<BookmarkProps>(defaultValues).has

hashCode

hashCode(): number
Returns number
Inherited from Immutable.Record<BookmarkProps>(defaultValues).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
- keyPath: Iterable<unknown>
Returns boolean
Inherited from Immutable.Record<BookmarkProps>(defaultValues).hasIn

merge

merge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                id: string | null;
                name: string | null;
                pdfBookmarkId: string | null;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              action: NutrientViewer.Actions.Action
              | null;
              id: string | null;
              name: string | null;
              pdfBookmarkId: string | null;
          },
      >
  )[]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).merge

mergeDeep

mergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                id: string | null;
                name: string | null;
                pdfBookmarkId: string | null;
            },
        >
    )[],
): this
Parameters
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              action: NutrientViewer.Actions.Action
              | null;
              id: string | null;
              name: string | null;
              pdfBookmarkId: string | null;
          },
      >
  )[]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
- keyPath: Iterable<unknown>
- ...collections: unknown[]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                id: string | null;
                name: string | null;
                pdfBookmarkId: string | null;
            },
        >
    )[],
): this
Parameters
- merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              action: NutrientViewer.Actions.Action
              | null;
              id: string | null;
              name: string | null;
              pdfBookmarkId: string | null;
          },
      >
  )[]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
- keyPath: Iterable<unknown>
- ...collections: unknown[]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).mergeIn

mergeWith

mergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: keyof {
            action: NutrientViewer.Actions.Action | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                id: string | null;
                name: string | null;
                pdfBookmarkId: string | null;
            },
        >
    )[],
): this
Parameters
- merger: (
      oldVal: unknown,
      newVal: unknown,
      key: keyof {
          action: NutrientViewer.Actions.Action | null;
          id: string | null;
          name: string | null;
          pdfBookmarkId: string | null;
      },
  ) => unknown
- ...collections: (
      | Iterable<[string, unknown], any, any>
      | Partial<
          {
              action: NutrientViewer.Actions.Action
              | null;
              id: string | null;
              name: string | null;
              pdfBookmarkId: string | null;
          },
      >
  )[]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).mergeWith

remove

remove<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
>(
    key: K,
): this
Type Parameters
- K extends keyof {
      action: NutrientViewer.Actions.Action | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }
Parameters
- key: K
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).removeIn

set

set<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
>(
    key: K,
    value: {
        action: NutrientViewer.Actions.Action | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    }[K],
): this
Type Parameters
- K extends keyof {
      action: NutrientViewer.Actions.Action | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }
Parameters
- key: K
- value: {
      action: NutrientViewer.Actions.Action | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }[K]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
- keyPath: Iterable<unknown>
- value: unknown
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).setIn

toJS

toJS(): {
    action: unknown;
    id: string
    | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
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 {
    action: unknown;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
- action: unknown
  The action that will be triggered when the bookmark is either clicked or tapped.
  
  Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.
- id: string | null
  A unique identifier to describe the bookmark. When a bookmark is created in the UI, the viewer has to generate a unique ID.
  
  When changes are saved to the underlying bookmark provider, we call Instance#ensureChangesSaved to make sure the annotation has been persisted from the provider.
- name: string | null
  optional
  
  An optional name to associate to the bookmark.
  Default
  null
- pdfBookmarkId: string | null
  When the bookmark is extracted directly from a PDF file, the pdfBookmarkId refers to the identifier that was used in the PDF document.
  
  This ID is optional since newly created bookmarks using the SYNCProvider annotation provider won't have a pdfBookmarkId assigned.
  Default
  null
Inherited from Immutable.Record<BookmarkProps>(defaultValues).toJS

toJSON

toJSON(): {
    action: NutrientViewer.Actions.Action
    | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
- action: NutrientViewer.Actions.Action | null
  The action that will be triggered when the bookmark is either clicked or tapped.
  
  Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.
- id: string | null
  A unique identifier to describe the bookmark. When a bookmark is created in the UI, the viewer has to generate a unique ID.
  
  When changes are saved to the underlying bookmark provider, we call Instance#ensureChangesSaved to make sure the annotation has been persisted from the provider.
- name: string | null
  optional
  
  An optional name to associate to the bookmark.
  Default
  null
- pdfBookmarkId: string | null
  When the bookmark is extracted directly from a PDF file, the pdfBookmarkId refers to the identifier that was used in the PDF document.
  
  This ID is optional since newly created bookmarks using the SYNCProvider annotation provider won't have a pdfBookmarkId assigned.
  Default
  null
Inherited from Immutable.Record<BookmarkProps>(defaultValues).toJSON

toObject

toObject(): {
    action: NutrientViewer.Actions.Action
    | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
- action: NutrientViewer.Actions.Action | null
  The action that will be triggered when the bookmark is either clicked or tapped.
  
  Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.
- id: string | null
  A unique identifier to describe the bookmark. When a bookmark is created in the UI, the viewer has to generate a unique ID.
  
  When changes are saved to the underlying bookmark provider, we call Instance#ensureChangesSaved to make sure the annotation has been persisted from the provider.
- name: string | null
  optional
  
  An optional name to associate to the bookmark.
  Default
  null
- pdfBookmarkId: string | null
  When the bookmark is extracted directly from a PDF file, the pdfBookmarkId refers to the identifier that was used in the PDF document.
  
  This ID is optional since newly created bookmarks using the SYNCProvider annotation provider won't have a pdfBookmarkId assigned.
  Default
  null
Inherited from Immutable.Record<BookmarkProps>(defaultValues).toObject

toSeq

toSeq(): Keyed<
    keyof {
        action: NutrientViewer.Actions.Action
        | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    },
    string
    | number
    | NutrientViewer.Actions.Action
    | null,
>
Returns Keyed<
    keyof {
        action: NutrientViewer.Actions.Action
        | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    },
    string
    | number
    | NutrientViewer.Actions.Action
    | null,
>
Inherited from Immutable.Record<BookmarkProps>(defaultValues).toSeq

update

update<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
>(
    key: K,
    updater: (
        value: {
            action: NutrientViewer.Actions.Action | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        }[K],
    ) => {
        action: NutrientViewer.Actions.Action
        | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    }[K],
): this
Type Parameters
- K extends keyof {
      action: NutrientViewer.Actions.Action | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }
Parameters
- key: K
- updater: (
      value: {
          action: NutrientViewer.Actions.Action | null;
          id: string | null;
          name: string | null;
          pdfBookmarkId: string | null;
      }[K],
  ) => {
      action: NutrientViewer.Actions.Action
      | null;
      id: string | null;
      name: string | null;
      pdfBookmarkId: string | null;
  }[K]
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
- keyPath: Iterable<unknown>
- updater: (value: unknown) => unknown
Returns this
Inherited from Immutable.Record<BookmarkProps>(defaultValues).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from Immutable.Record<BookmarkProps>(defaultValues).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
Map#withMutations

Inherited from Immutable.Record<BookmarkProps>(defaultValues).withMutations

`Static`fromSerializableObject

fromSerializableObject(bookmark: BookmarkJSON): NutrientViewer.Bookmark
Bookmark deserializer. Converts a bookmark object to a NutrientViewer.Bookmark.
Parameters
- bookmark: BookmarkJSON
Returns NutrientViewer.Bookmark

Class Bookmark

Example

See

Hierarchy

Index

Properties

Methods

Properties

action

id

Readonlyname

Default

ReadonlypdfBookmarkId

Default

StaticdisplayName

StatictoSerializableObject

Methods

[iterator]

Returns IterableIterator< [ keyof { action: NutrientViewer.Actions.Action | null; id: string | null; name: string | null; pdfBookmarkId: string | null; }, string | number | NutrientViewer.Actions.Action | null, ],>

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 { action: NutrientViewer.Actions.Action | null; id: string | null; name: string | null; pdfBookmarkId: string | null;}[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns unknown

has

Parameters

Returns key is "id" | "name" | "action" | "pdfBookmarkId" | "sortKey"

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

remove

Type Parameters

Parameters

Returns this

removeIn

`Readonly`name

`Readonly`pdfBookmarkId

`Static`displayName

`Static`toSerializableObject

Returns IterableIterator<
[
keyof {
action: NutrientViewer.Actions.Action
| null;
id: string | null;
name: string | null;
pdfBookmarkId: string | null;
},
string
| number
| NutrientViewer.Actions.Action
| null,
],
>

Returns {
action: NutrientViewer.Actions.Action | null;
id: string | null;
name: string | null;
pdfBookmarkId: string | null;
}[K]

Returns {
action: unknown;
id: string | null;
name: string | null;
pdfBookmarkId: string | null;
}

Returns {
action: NutrientViewer.Actions.Action | null;
id: string | null;
name: string | null;
pdfBookmarkId: string | null;
}

Returns {
action: NutrientViewer.Actions.Action | null;
id: string | null;
name: string | null;
pdfBookmarkId: string | null;
}

Returns Keyed<
keyof {
action: NutrientViewer.Actions.Action
| null;
id: string | null;
name: string | null;
pdfBookmarkId: string | null;
},
string
| number
| NutrientViewer.Actions.Action
| null,
>

`Static`fromSerializableObject