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

RecordTextLine

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.

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.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,
    ],
>
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,
    ],
>
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: 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<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | 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 {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).equals

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | 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 {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}[K]
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).getIn

has

has(
    key: string,
): key is
    | "id"
    | "pageIndex"
    | "boundingBox"
    | "contents"
    | "visualTextRange"
    | "hints"
    | "syntheticTextSelectionFont"
    | "syntheticTextSelectionRuns"
Parameters
keystring
Returns
key is
| "id"
| "pageIndex"
| "boundingBox"
| "contents"
| "visualTextRange"
| "hints"
| "syntheticTextSelectionFont"
| "syntheticTextSelectionRuns"
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).has

hashCode

hashCode(): number
Returns
number
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                boundingBox: NutrientViewer.Geometry.Rect;
                contents: string;
                hints: Hints
                | null;
                id: number | null;
                pageIndex: number | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                boundingBox: NutrientViewer.Geometry.Rect;
                contents: string;
                hints: Hints
                | null;
                id: number | null;
                pageIndex: number | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                boundingBox: NutrientViewer.Geometry.Rect;
                contents: string;
                hints: Hints
                | null;
                id: number | null;
                pageIndex: number | null;
            },
        >
    )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).mergeIn

mergeWith

mergeWith(
    merger: (oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints | null;
            id: number | null;
            pageIndex: number | null;
        },
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                boundingBox: NutrientViewer.Geometry.Rect;
                contents: string;
                hints: Hints
                | null;
                id: number | null;
                pageIndex: number | null;
            },
        >
    )[],
): this
Parameters
merger
(oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown(
    oldVal: unknown,
    newVal: unknown,
    key: keyof {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    },
) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K,
): this
Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: Hints
            | null;
            id: number | null;
            pageIndex: number | null;
        },
>(
    key: K,
    value: {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: Hints | null;
        id: number | null;
        pageIndex: number | null;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK
value
{ … }[K]{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}[K]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).setIn

toJS

toJS(): { … }toJS(): {
    boundingBox: unknown;
    contents: string;
    hints: unknown;
    id: number
    | null;
    pageIndex: number | 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
{ … }{
    boundingBox: unknown;
    contents: string;
    hints: unknown;
    id: number | null;
    pageIndex: number | null;
}
boundingBox: unknown
Position of this text line on the page.

contents: string
Content of the text line.

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

hints: unknown
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.
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).toJS

toJSON

toJSON(): { … }toJSON(): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints
    | null;
    id: number | null;
    pageIndex: number | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.
Returns
{ … }{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
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.
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).toJSON

toObject

toObject(): { … }toObject(): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints
    | null;
    id: number | null;
    pageIndex: number | null;
}
Shallowly converts this Record to equivalent JavaScript Object.
Returns
{ … }{
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
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.
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).toObject

toSeq

toSeq(): Keyed<
    keyof { … },
    | string
    | number
    | NutrientViewer.Geometry.Rect
    | { length: number; start: number }
    | Hints
    | { … }
    | { … }[]
    | null,
>toSeq(): Keyed<
    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,
>
Returns
Keyed<
keyof { … },
| string
| number
| NutrientViewer.Geometry.Rect
| { length: number; start: number }
| Hints
| { … }
| { … }[]
| null
>Keyed<
    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,
>
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).toSeq

update

update<K extends keyof { … }>(
    key: K,
    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,
    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
Type Parameters
K
extends keyof { … }extends keyof {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: Hints | null;
    id: number | null;
    pageIndex: number | null;
}
Parameters
keyK
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]
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).updateIn

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).wasAltered

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', visualTextRange: null, hints: null, syntheticTextSelectionFont: null, syntheticTextSelectionRuns: null, }).withMutations

Class TextLine

Hierarchy

Properties

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

boundingBox: unknown

contents: string

hints: unknown

id: number | null

pageIndex: number | 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

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

See Also

Parameters

Returns