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.

Class

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

Hierarchy

RecordBookmark

Properties

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

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.

name

Readonly

string | null

optional

An optional name to associate to the bookmark.

Default Value

null

pdfBookmarkId

Readonly

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 Value

null

Methods

fromSerializableObject

Static

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

Parameters
bookmarkBookmarkJSON
Returns
NutrientViewer.Bookmark

toSerializableObject

Static

toSerializableObject(bookmark: NutrientViewer.Bookmark): BookmarkJSON
Bookmark serializer. Converts a bookmark to InstantJSON compliant objects.

Parameters
bookmarkNutrientViewer.Bookmark
Returns
BookmarkJSON

Immutable Record API

displayName

Static

string

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

[iterator]

"[iterator]"(): IterableIterator<
    [keyof { … }, string | number | NutrientViewer.Actions.Action | null],
>"[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 { … }, string | number | NutrientViewer.Actions.Action | null]
>IterableIterator<
    [
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
        string
        | number
        | NutrientViewer.Actions.Action
        | null,
    ],
>
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from ImmutableRecord<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 ImmutableRecord<BookmarkProps>(defaultValues).clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    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 { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).equals

get

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

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).getIn

has

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

hashCode

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

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...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<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...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<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).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<
            {
                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<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).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 {
            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 { … }) => unknown(
    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<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            id: string | null;
            name: string | null;
            pdfBookmarkId: string | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
    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 { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    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 { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
Parameters
keyK
value
{ … }[K]{
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}[K]
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).setIn

toJS

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 Value
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 Value
null
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).toJS

toJSON

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 Value
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 Value
null
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).toJSON

toObject

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 Value
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 Value
null
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).toObject

toSeq

toSeq(): Keyed<
    keyof { … },
    string
    | number
    | NutrientViewer.Actions.Action
    | null,
>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 { … }, string | number | NutrientViewer.Actions.Action | null>Keyed<
    keyof {
        action: NutrientViewer.Actions.Action
        | null;
        id: string | null;
        name: string | null;
        pdfBookmarkId: string | null;
    },
    string
    | number
    | NutrientViewer.Actions.Action
    | null,
>
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).toSeq

update

update<K extends keyof { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    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 { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    id: string | null;
    name: string | null;
    pdfBookmarkId: string | null;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    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 ImmutableRecord<BookmarkProps>(defaultValues).update

updateIn

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

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from ImmutableRecord<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 Also
Map#withMutations
Inherited from ImmutableRecord<BookmarkProps>(defaultValues).withMutations

Class Bookmark

Example

See Also

Hierarchy

Properties

Default Value

Default Value

Methods

Parameters

Returns

Parameters

Returns

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

action: unknown

id: string | null

name: string | null

Default Value

pdfBookmarkId: string | null

Default Value

Returns

action: NutrientViewer.Actions.Action | null

id: string | null

name: string | null

Default Value

pdfBookmarkId: string | null

Default Value

Returns

action: NutrientViewer.Actions.Action | null

id: string | null

name: string | null

Default Value