Class CPDFLineAnnotation

CPDFLineAnnotation

Hierarchy (View Summary)

CPDFAnnotation
- CPDFLineAnnotation

Index

Constructors

constructor

new CPDFLineAnnotation(params: Partial<CPDFLineAnnotation>): CPDFLineAnnotation
Parameters
- params: Partial<CPDFLineAnnotation>
Returns CPDFLineAnnotation
Overrides CPDFAnnotation.constructor

Methods

`Static`fromJson

fromJson<T extends CPDFAnnotation>(
this: new (params: Partial<T>) => T,
json: any,
): T
Type Parameters
- T extends CPDFAnnotation
Parameters
- this: new (params: Partial<T>) => T
- json: any
Returns T
Inherited from CPDFAnnotation.fromJson

`Static`fromJsonArray

fromJsonArray<T extends CPDFAnnotation>(
this: new (params: Partial<T>) => T,
jsonArray: any[],
): T[]
Type Parameters
- T extends CPDFAnnotation
Parameters
- this: new (params: Partial<T>) => T
- jsonArray: any[]
Returns T[]
Inherited from CPDFAnnotation.fromJsonArray

update

update(
    updates: Partial<
        Pick<
            CPDFLineAnnotation,
            | "title"
            | "content"
            | "borderColor"
            | "borderAlpha"
            | "fillColor"
            | "fillAlpha"
            | "borderWidth"
            | "lineHeadType"
            | "lineTailType"
            | "dashGap",
        >,
    >,
): this
Update line annotation properties with type safety
Parameters
- updates: Partial<
      Pick<
          CPDFLineAnnotation,
          | "title"
          | "content"
          | "borderColor"
          | "borderAlpha"
          | "fillColor"
          | "fillAlpha"
          | "borderWidth"
          | "lineHeadType"
          | "lineTailType"
          | "dashGap",
      >,
  >
  Partial object containing properties to update
Returns this
this instance for chaining
Example
```
lineAnnotation.update({
  title: 'Updated Title',
  content: 'Updated content',
  borderColor: '#FF0000',
  borderAlpha: 200,
  borderWidth: 2,
  fillColor: '#00FF00',
  fillAlpha: 150,
  lineHeadType: CPDFLineType.ARROW,
  lineTailType: CPDFLineType.NONE
});
await document.updateAnnotation(lineAnnotation);
```
Overrides CPDFAnnotation.update

toJSON

toJSON(): Omit<CPDFLineAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    borderColor: string;
    borderAlpha: number;
    fillColor: string;
    fillAlpha: number;
    borderWidth: number;
    lineHeadType: string;
    lineTailType: string;
    points: number[][];
    dashGap: number;
}
Returns Omit<CPDFLineAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    borderColor: string;
    borderAlpha: number;
    fillColor: string;
    fillAlpha: number;
    borderWidth: number;
    lineHeadType: string;
    lineTailType: string;
    points: number[][];
    dashGap: number;
}
Overrides CPDFAnnotation.toJSON

Properties

type

type: CPDFAnnotationType

Annotation type identifier

title

title: string

Annotation title

`Readonly`page

page: number

The page number where the note is located

content

content: string

annotation content.

`Readonly`uuid

uuid: string

annotation uuid.

createDate

createDate: Date | null = null

annotation create date.

markState

markState: CPDFAnnotationMarkState = CPDFAnnotationMarkState.UNMARKED

annotation mark state.

reviewState

reviewState: CPDFAnnotationReviewState = CPDFAnnotationReviewState.NONE

annotation review state.

rect

rect: CPDFRectF | null = null

annotation rect.

borderColor

borderColor: string

The color of the border.

borderAlpha

borderAlpha: number

The alpha of the border.

fillColor

fillColor: string

The color of the fill.

fillAlpha

fillAlpha: number

The alpha of the fill.

borderWidth

borderWidth: number

The width of the border.

lineHeadType

lineHeadType: string

The type of the line head.

lineTailType

lineTailType: string

The type of the line tail.

points

points: number[][]

The points defining the line annotation.

dashGap

dashGap: number

Class CPDFLineAnnotation

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns CPDFLineAnnotation

Methods

StaticfromJson

Type Parameters

Parameters

Returns T

StaticfromJsonArray

Type Parameters

Parameters

Returns T[]

update

Parameters

Returns this

Example

toJSON

Returns Omit<CPDFLineAnnotation, "createDate" | "update" | "toJSON"> & { createDate?: number; borderColor: string; borderAlpha: number; fillColor: string; fillAlpha: number; borderWidth: number; lineHeadType: string; lineTailType: string; points: number[][]; dashGap: number;}

Properties

type

title

Readonlypage

content

Readonlyuuid

createDate

markState

reviewState

rect

borderColor

borderAlpha

fillColor

fillAlpha

borderWidth

lineHeadType

lineTailType

points

dashGap

Settings

On This Page

`Static`fromJson

`Static`fromJsonArray

Returns Omit<CPDFLineAnnotation, "createDate" | "update" | "toJSON"> & {
createDate?: number;
borderColor: string;
borderAlpha: number;
fillColor: string;
fillAlpha: number;
borderWidth: number;
lineHeadType: string;
lineTailType: string;
points: number[][];
dashGap: number;
}

`Readonly`page

`Readonly`uuid