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.

Hierarchy

Record<
    {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: null
        | Hints;
        id: null | number;
        pageIndex: null | number;
    },
    this,
> & Readonly<
    {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: null
        | Hints;
        id: null | number;
        pageIndex: null | number;
    },
>
- TextLine

Properties

`Readonly`boundingBox

boundingBox: NutrientViewer.Geometry.Rect

Position of this text line on the page.

`Readonly`contents

contents: string

Content of the text line.

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

`Readonly`hints

hints: null | Hints

Hints for the text line.

`Readonly`id

id: null | number

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

`Readonly`pageIndex

pageIndex: null | number

The page index on which the text line is placed.

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

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: null
            | Hints;
            id: null | number;
            pageIndex: null | number;
        },
        null
        | string
        | number
        | NutrientViewer.Geometry.Rect
        | Hints,
    ],
>
Returns IterableIterator<
    [
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: null
            | Hints;
            id: null | number;
            pageIndex: null | number;
        },
        null
        | string
        | number
        | NutrientViewer.Geometry.Rect
        | Hints,
    ],
>
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).[iterator]

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

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

delete

delete<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: null
            | Hints;
            id: null | number;
            pageIndex: null | number;
        },
>(
    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 {
      boundingBox: NutrientViewer.Geometry.Rect;
      contents: string;
      hints: null | Hints;
      id: null | number;
      pageIndex: null | number;
  }
Parameters
- key: K
Returns this
Alias
remove

Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).delete

deleteIn

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

Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).equals

get

get<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: null
            | Hints;
            id: null | number;
            pageIndex: null | number;
        },
>(
    key: K,
    notSetValue?: any,
): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: null | Hints;
    id: null | number;
    pageIndex: null | number;
}[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 {
      boundingBox: NutrientViewer.Geometry.Rect;
      contents: string;
      hints: null | Hints;
      id: null | number;
      pageIndex: null | number;
  }
Parameters
- key: K
- OptionalnotSetValue: any
Returns {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: null | Hints;
    id: null | number;
    pageIndex: null | number;
}[K]
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).getIn

has

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

hashCode

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

hasIn

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

merge

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

mergeDeep

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

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).mergeDeepIn

mergeDeepWith

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

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).mergeIn

mergeWith

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

remove

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

removeIn

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

set

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

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).setIn

toJS

toJS(): { boundingBox: any; contents: any; hints: any; id: any; pageIndex: any }
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns { boundingBox: any; contents: any; hints: any; id: any; pageIndex: any }
- boundingBox: any
  Position of this text line on the page.
- contents: any
  Content of the text line.
  
  Text lines end with CRLF (\r\n).
- hints: any
  Hints for the text line.
- id: any
  An ID that is unique inside one page to reference the text line across the document.
- pageIndex: any
  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: '', hints: null, }).toJS

toJSON

toJSON(): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: null
    | Hints;
    id: null | number;
    pageIndex: null | number;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: null | Hints;
    id: null | number;
    pageIndex: null | number;
}
- 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: null | Hints
  Hints for the text line.
- id: null | number
  An ID that is unique inside one page to reference the text line across the document.
- pageIndex: null | number
  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: '', hints: null, }).toJSON

toObject

toObject(): {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: null
    | Hints;
    id: null | number;
    pageIndex: null | number;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns {
    boundingBox: NutrientViewer.Geometry.Rect;
    contents: string;
    hints: null | Hints;
    id: null | number;
    pageIndex: null | number;
}
- 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: null | Hints
  Hints for the text line.
- id: null | number
  An ID that is unique inside one page to reference the text line across the document.
- pageIndex: null | number
  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: '', hints: null, }).toObject

toSeq

toSeq(): Keyed<
    keyof {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: null
        | Hints;
        id: null | number;
        pageIndex: null | number;
    },
    null
    | string
    | number
    | NutrientViewer.Geometry.Rect
    | Hints,
>
Returns Keyed<
    keyof {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: null
        | Hints;
        id: null | number;
        pageIndex: null | number;
    },
    null
    | string
    | number
    | NutrientViewer.Geometry.Rect
    | Hints,
>
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).toSeq

update

update<
    K extends
        keyof {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: null
            | Hints;
            id: null | number;
            pageIndex: null | number;
        },
>(
    key: K,
    updater: (
        value: {
            boundingBox: NutrientViewer.Geometry.Rect;
            contents: string;
            hints: null | Hints;
            id: null | number;
            pageIndex: null | number;
        }[K],
    ) => {
        boundingBox: NutrientViewer.Geometry.Rect;
        contents: string;
        hints: null
        | Hints;
        id: null | number;
        pageIndex: null | number;
    }[K],
): this
Type Parameters
- K extends keyof {
      boundingBox: NutrientViewer.Geometry.Rect;
      contents: string;
      hints: null | Hints;
      id: null | number;
      pageIndex: null | number;
  }
Parameters
- key: K
- updater: (
      value: {
          boundingBox: NutrientViewer.Geometry.Rect;
          contents: string;
          hints: null | Hints;
          id: null | number;
          pageIndex: null | number;
      }[K],
  ) => {
      boundingBox: NutrientViewer.Geometry.Rect;
      contents: string;
      hints: null
      | Hints;
      id: null | number;
      pageIndex: null | number;
  }[K]
Returns this
Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).update

updateIn

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

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).wasAltered

withMutations

withMutations(mutator: (mutable: this) => any): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
- mutator: (mutable: this) => any
Returns this
See
Map#withMutations

Inherited from ImmutableRecord<ITextLine>({ id: null, pageIndex: null, boundingBox: new Rect(), contents: '', hints: null, }).withMutations

Class TextLine

Hierarchy

Index

Properties

Methods

Properties

ReadonlyboundingBox

Readonlycontents

Readonlyhints

Readonlyid

ReadonlypageIndex

Methods

[iterator]

Returns IterableIterator< [ keyof { boundingBox: NutrientViewer.Geometry.Rect; contents: string; hints: null | Hints; id: null | number; pageIndex: null | number; }, null | string | number | NutrientViewer.Geometry.Rect | Hints, ],>

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 { boundingBox: NutrientViewer.Geometry.Rect; contents: string; hints: null | Hints; id: null | number; pageIndex: null | number;}[K]

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

has

Parameters

Returns key is "id" | "pageIndex" | "boundingBox" | "contents" | "hints"

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

Parameters

Returns this

set

Type Parameters

Parameters

`Readonly`boundingBox

`Readonly`contents

`Readonly`hints

`Readonly`id

`Readonly`pageIndex

Returns IterableIterator<
[
keyof {
boundingBox: NutrientViewer.Geometry.Rect;
contents: string;
hints: null
| Hints;
id: null | number;
pageIndex: null | number;
},
null
| string
| number
| NutrientViewer.Geometry.Rect
| Hints,
],
>

Returns {
boundingBox: NutrientViewer.Geometry.Rect;
contents: string;
hints: null | Hints;
id: null | number;
pageIndex: null | number;
}[K]

Returns {
boundingBox: NutrientViewer.Geometry.Rect;
contents: string;
hints: null | Hints;
id: null | number;
pageIndex: null | number;
}

Returns {
boundingBox: NutrientViewer.Geometry.Rect;
contents: string;
hints: null | Hints;
id: null | number;
pageIndex: null | number;
}

Returns Keyed<
keyof {
boundingBox: NutrientViewer.Geometry.Rect;
contents: string;
hints: null
| Hints;
id: null | number;
pageIndex: null | number;
},
null
| string
| number
| NutrientViewer.Geometry.Rect
| Hints,
>