Reference NutrientViewerTextLine

Class TextLine

A line of text displayed at a specific bounding box in the PDF file.

You can retrieve text lines using NutrientViewer.Instance#textLinesForPageIndex.

Class

Hierarchy

ReadonlyImmutableRecordTextLine

Properties

boundingBox

Readonly

NutrientViewer.Geometry.Rect

Position of this text line on the page.

Readonly

string

Content of the text line.

Text lines end with CRLF (\r\n).

hints

Readonly

Hints | null

Hints for the text line.

id

Readonly

number | null

An ID that is unique inside one page to reference the text line across the document.

pageIndex

Readonly

number | null

The page index on which the text line is placed.

pageIndex is zero-based and has a maximum value of totalPageCount - 1.

Methods

entries

entries(): IterableIterator<[string, unknown]>
Returns the record's [key, value] pairs, in the order its fields were defined.

Returns
IterableIterator<[string, unknown]>
An iterator over the record's fields.

Immutable Record API

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof { … },
        | string
        | number
        | NutrientViewer.Geometry.Rect
        | { length: number; start: number }
        | Hints
        | { … }
        | { … }[]
        | null,
    ],
>"[iterator]"(): IterableIterator<
    [
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
        | string
        | number
        | NutrientViewer.Geometry.Rect
        | { length: number; start: number }
        | Hints
        | {
            ascender: number;
            descender: number;
            glyphs: [text: string, advanceWidth: number][];
            key: string;
            ligatures?: [components: string, advanceWidth: number][];
            unitsPerEm: number;
        }
        | {
            range: { length: number; start: number };
            syntheticTextSelectionFont: {
                ascender: number;
                descender: number;
                glyphs: [text: string, advanceWidth: number][];
                key: string;
                ligatures?: [components: string, advanceWidth: number][];
                unitsPerEm: number;
            };
        }[]
        | null,
    ],
>
Iterates the [key, value] pairs, in the order the fields were defined.

Returns
IterableIterator<
[
keyof { … },
| string
| number
| NutrientViewer.Geometry.Rect
| { length: number; start: number }
| Hints
| { … }
| { … }[]
| null
]
>IterableIterator<
    [
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
        | string
        | number
        | NutrientViewer.Geometry.Rect
        | { length: number; start: number }
        | Hints
        | {
            ascender: number;
            descender: number;
            glyphs: [text: string, advanceWidth: number][];
            key: string;
            ligatures?: [components: string, advanceWidth: number][];
            unitsPerEm: number;
        }
        | {
            range: { length: number; start: number };
            syntheticTextSelectionFont: {
                ascender: number;
                descender: number;
                glyphs: [text: string, advanceWidth: number][];
                key: string;
                ligatures?: [components: string, advanceWidth: number][];
                unitsPerEm: number;
            };
        }[]
        | null,
    ],
>

clear

clear(): this
Returns a record with every key reset to the default it was defined with.

Returns
this
A new record holding only default values.

delete

delete<K extends keyof { … }>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
): thisdelete<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
): this
Returns a record with key reset to the default it was defined with.

Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints")
One of the keys this record was defined with.

Returns
this
A new record, or this one when the value already equals the default.

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Returns a record with the value at keyPath removed. A field of this record is reset to its default; a key of a nested collection or plain object is deleted.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
this
A new record, or this one when nothing was removed.

equals

Deprecated

equals(other: unknown): boolean
Reports whether other is a record holding the same keys with equal values, whatever its class.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when both hold the same keys and every value matches.

Deprecated
Records of different classes with identical values compare equal. Use isEqual(), which also requires both records to be of the same class.

get

get<K extends keyof { … }, N = never>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
    notSetValue?: N,
): N | { … }[K]get<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    N = never,
>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
    notSetValue?: N,
):
    | N
    | {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints
        | null;
        id: number | null;
        pageIndex: number | null;
    }[K]
Returns the value stored under key.

Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
N = never
Parameters
keyK & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints")
One of the keys this record was defined with.

notSetValueN
Optional
Returned when the record does not define key.

Returns
N | { … }[K]
    | N
    | {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints
        | null;
        id: number | null;
        pageIndex: number | null;
    }[K]
The current value for that key.

getIn

getIn(keyPath: Iterable<unknown>): unknown
Returns the value at keyPath, walking nested records and collections.

A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
unknown
The value at that path, or undefined when it does not resolve.
getIn<N>(keyPath: Iterable<unknown>, notSetValue: N): unknown
Returns the value at keyPath, walking nested records and collections.

A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

Type Parameters
N
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueN
Returned when the path does not resolve.

Returns
unknown
The value at that path, or notSetValue.

has

has(
key: string,
): key is "id" | "pageIndex" | "boundingBox" | "contents" | "hints"
Reports whether key is one of the keys this record was defined with.

A literal key must name a field; a key typed as string is narrowed to the field names.

Parameters
keystring
The key to look for.

Returns
key is "id" | "pageIndex" | "boundingBox" | "contents" | "hints"
true when the record defines that key, even if its value is null.

hashCode

hashCode(): number
Computes a hash of this record from its contents, the same way Immutable.js does. Equal records have equal hashes; records with equal hashes are not necessarily equal. Plain objects, functions and symbols hash by identity, so a hash is only meaningful within the page that computed it.

Returns
number
An integer hash.

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Reports whether keyPath resolves, walking nested records and collections.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
boolean
true when every key along the path is present.

isEqual

isEqual(other: unknown): boolean
Reports whether other is a record of the same class holding equal values. Only the two records' own classes are compared; nested records compare as equals() does.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when both are the same class and every value matches.

merge

merge(
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismerge(
    ...collections: (
        | Partial<
            {
                boundingBox: NutrientViewer.Geometry.Rect;
                contents: string;
                hints: Hints
                | null;
                id: number | null;
                pageIndex: number | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection applied in order.

Keys the record was not defined with are ignored.

Parameters
...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to apply.

Returns
this
A new record, or this one when no value changed.

mergeDeep

mergeDeep(
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeDeep(
    ...collections: (
        | Partial<
            {
                id: number
                | null;
                pageIndex: number | null;
                boundingBox:
                    | NutrientViewer.Geometry.Rect
                    | Partial<{ height: number; left: number; top: number; width: number }>;
                contents: string;
                hints: Hints | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in, recursing into nested collections and plain objects instead of replacing them.

Keys the record was not defined with are ignored.

Parameters
...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            id: number
            | null;
            pageIndex: number | null;
            boundingBox:
                | NutrientViewer.Geometry.Rect
                | Partial<{ height: number; left: number; top: number; width: number }>;
            contents: string;
            hints: Hints | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Returns a record with each collection merged deeply into the value at keyPath.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
this
A new record, or this one when the value is unchanged.

mergeDeepWith

mergeDeepWith(
    merger: (previous: unknown, next: unknown, key: unknown) => unknown,
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeDeepWith(
    merger: (previous: unknown, next: unknown, key: unknown) => unknown,
    ...collections: (
        | Partial<
            {
                id: number
                | null;
                pageIndex: number | null;
                boundingBox:
                    | NutrientViewer.Geometry.Rect
                    | Partial<{ height: number; left: number; top: number; width: number }>;
                contents: string;
                hints: Hints | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in deeply, calling merger where a nested value is not a collection to decide the value that is kept.

Keys the record was not defined with are ignored.

Parameters
merger(previous: unknown, next: unknown, key: unknown) => unknown
Receives the current value, the incoming value and the key.

...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            id: number
            | null;
            pageIndex: number | null;
            boundingBox:
                | NutrientViewer.Geometry.Rect
                | Partial<{ height: number; left: number; top: number; width: number }>;
            contents: string;
            hints: Hints | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Returns a record with each collection merged into the value at keyPath, one level at a time.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
this
A new record, or this one when the value is unchanged.

mergeWith

mergeWith(
    merger: <K extends string | number | symbol>(
        previous: { … }[K],
        next: { … }[K],
        key: K,
    ) => { … }[K],
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeWith(
    merger: <K extends string | number | symbol>(
        previous: {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints | null;
            id: number | null;
            pageIndex: number | null;
        }[K],
        next: {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints | null;
            id: number | null;
            pageIndex: number | null;
        }[K],
        key: K,
    ) => {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
    ...collections: (
        | Partial<
            {
                boundingBox: NutrientViewer.Geometry.Rect;
                contents: string;
                hints: Hints
                | null;
                id: number | null;
                pageIndex: number | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in, calling merger for each key the record already holds to decide the value that is kept.

Keys the record was not defined with are ignored.

Parameters
merger
<K extends string | number | symbol>(
previous: { … }[K],
next: { … }[K],
key: K
) => { … }[K]<K extends string | number | symbol>(
    previous: {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
    next: {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
    key: K,
) => {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}[K]
Receives the current value, the incoming value and the key.

...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

remove

remove<K extends keyof { … }>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
): thisremove<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
): this
An alias for delete.

Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints")
One of the keys this record was defined with.

Returns
this
A new record, or this one when the value already equals the default.

removeIn

removeIn(keyPath: Iterable<unknown>): this
An alias for deleteIn.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
this
A new record, or this one when nothing was removed.

set

set<K extends keyof { … }>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
    value: { … }[K],
): thisset<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
    value: {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
): this
Returns a record with key set to value.

Setting a key to the value it already holds returns the same instance, so a record can be compared by reference to detect a change.

Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints")
One of the keys this record was defined with.

value
{ … }[K]{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}[K]
The value to store.

Returns
this
A new record, or this one when the value is unchanged or the key is not defined.

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Returns a record with value written at keyPath.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

valueunknown
The value to store.

Returns
this
A new record, or this one when the value is unchanged.

toJS

toJS(): { … }toJS(): {
    id: number
    | null;
    pageIndex: number | null;
    boundingBox: { left: number; top: number; width: number; height: number };
    contents: string;
    hints: Hints | null;
}
Converts this record and everything nested inside it to plain JavaScript values.
Returns
{ … }{
    id: number | null;
    pageIndex: number | null;
    boundingBox: { left: number; top: number; width: number; height: number };
    contents: string;
    hints: Hints | null;
}
A plain object holding this record's values, converted all the way down.

id: number | null
An ID that is unique inside one page to reference the text line across the document.

pageIndex: number | null
The page index on which the text line is placed.

pageIndex is zero-based and has a maximum value of totalPageCount - 1.

boundingBox: { left: number; top: number; width: number; height: number }
Position of this text line on the page.

left: number
The left distance of the rect. This is equivalent to x of a NutrientViewer.Geometry.Point.

Default Value
0
top: number
The top distance of the rect. This is equivalent to y of a NutrientViewer.Geometry.Point.

Default Value
0
width: number
The width of the rect. This is equivalent to width of a NutrientViewer.Geometry.Size.

Default Value
0
height: number
The height of the rect. This is equivalent to height of a NutrientViewer.Geometry.Size.

Default Value
0
contents: string
Content of the text line.

Text lines end with CRLF (\r\n).

hints: Hints | null
Hints for the text line.

toJSON

toJSON(): { … }toJSON(): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints
    | null;
    id: number | null;
    pageIndex: number | null;
}
An alias for toObject, called by JSON.stringify.
Returns
{ … }{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
A plain object holding this record's values.

boundingBox: NutrientViewer.Geometry.Rect
Position of this text line on the page.

contents: string
Content of the text line.

Text lines end with CRLF (\r\n).

hints: Hints | null
Hints for the text line.

id: number | null
An ID that is unique inside one page to reference the text line across the document.

pageIndex: number | null
The page index on which the text line is placed.

pageIndex is zero-based and has a maximum value of totalPageCount - 1.

toObject

toObject(): { … }toObject(): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints
    | null;
    id: number | null;
    pageIndex: number | null;
}
Converts this record to a plain object, one level deep. Nested records are left as they are.
Returns
{ … }{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
A plain object holding this record's values.

boundingBox: NutrientViewer.Geometry.Rect
Position of this text line on the page.

contents: string
Content of the text line.

Text lines end with CRLF (\r\n).

hints: Hints | null
Hints for the text line.

id: number | null
An ID that is unique inside one page to reference the text line across the document.

pageIndex: number | null
The page index on which the text line is placed.

pageIndex is zero-based and has a maximum value of totalPageCount - 1.

update

update<K extends keyof { … }>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints"),
    updater: (
        value: {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints | null;
            id: number | null;
            pageIndex: number | null;
        }[K],
    ) => {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints
        | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
): this
Returns a record with key replaced by the result of applying updater to its current value.

Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK & ("id" | "pageIndex" | "boundingBox" | "contents" | "hints")
One of the keys this record was defined with.

updater
(value: { … }[K]) => { … }[K](
    value: {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
) => {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints
    | null;
    id: number | null;
    pageIndex: number | null;
}[K]
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

updateIn

updateIn<N>(
    keyPath: Iterable<unknown>,
    notSetValue: N,
    updater: (value: unknown) => unknown,
): this
Returns a record with the value at keyPath replaced by the result of updater.

Type Parameters
N
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueN
updater(value: unknown) => unknown
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Returns a record with the value at keyPath replaced by the result of updater.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

updater(value: unknown) => unknown
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Applies several changes as one, so only a single new record is allocated.

The record handed to mutator may be written to with set; it is frozen again once mutator returns.

Parameters
mutator(mutable: this) => unknown
Receives a temporarily writable copy of this record.

Returns
this
A new record holding the applied changes, or this one when nothing changed.

Class TextLine

Hierarchy

Properties

Methods

Returns

Immutable Record API

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

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

id: number | null

pageIndex: number | null

boundingBox: { left: number; top: number; width: number; height: number }

left: number

Default Value

top: number

Default Value

width: number

Default Value

height: number

Default Value

contents: string

hints: Hints | null

Returns

boundingBox: NutrientViewer.Geometry.Rect

contents: string

hints: Hints | null

id: number | null

pageIndex: number | null

Returns

boundingBox: NutrientViewer.Geometry.Rect

contents: string

hints: Hints | null

id: number | null

pageIndex: number | null

Type Parameters