AnnotationBase | PDFビューワ APIリファレンス

すべての注釈モデルの基本クラス。

階層

AnnotationBase

インデックス

プロパティ

annotationName

annotationName: string

注釈名（NMエントリ）。

annotationType

annotationType: AnnotationTypeCode

注釈の種類。

オプション appearanceColor

appearanceColor: undefined | string

外観の色。

オプション borderStyle

borderStyle: undefined | { dashArray?: number[]; horizontalCornerRadius: number; style: number; verticalCornerRadius: number; width: number }

注釈の境界線スタイル。

オプション color

color: undefined | string

注釈の色。

オプション contents

contents: undefined | string

注釈を開いたときにポップアップに表示されるテキスト（またはリッチテキスト）文字列。

オプション convertToContent

convertToContent: undefined | false | true

ドキュメントの保存時に注釈をコンテンツに変換するかどうかを示します。

creationDate

creationDate: string

作成日。

オプション display

display: "visible" | "hidden"

このフィールドは、Adobe AcrobatReaderとの互換性のために使用されます。

オプション gcProps

gcProps: GcProps

追加のカスタムプロパティ。 GcPdfでのみ使用できます。

id

id: string

注釈ID。

invisibleFlag

invisibleFlag: boolean

注釈が非表示にする場合はtrue。

オプション irtAnnotations

irtAnnotations: AnnotationBase[]

内部プロパティ。親注釈の子注釈。配列にはすべての子の注釈が含まれ、親の注釈の直接の子孫ではない注釈も含まれることに注意します。

isRichContents

isRichContents: boolean

コンテンツプロパティにRichContentモードを使用するかどうかを指定します。

locked

locked: boolean

注釈を編集できるかどうかを指定します。

サンプル

var viewer = new GcPdfViewer('#root', { renderInteractiveForms: true , supportApi: { apiUrl: 'api/pdf-viewer', webSocketUrl: false } }); 
viewer.addDefaultPanels(); 
viewer.addAnnotationEditorPanel(); 
viewer.addFormEditorPanel(); 
viewer.addReplyTool(); 
viewer.onAfterOpen.register(()=>{ 
    // ドキュメントを開いた後、すべてのテキスト注釈をロックします。 
    const resultArr = await viewer.findAnnotation(1, // 1 - AnnotationTypeCode.TEXT 
                          { findField: 'annotationType', 
                              pageNumberConstraint: 1, findAll: true }); 
    viewer.updateAnnotations(0, resultArr.map((data)=> { data.annotation.locked = true; return data.annotation; })); 
}); 
// Annotations.pdfファイルを開きます。 
viewer.open('Annotations.pdf');

modificationDate

modificationDate: string

変更日。

オプション opacity

opacity: undefined | number

注釈の不透明度。

orderIndex

orderIndex: number

フィールドの順序インデックス。

オプション parentAnnotation

parentAnnotation: AnnotationBase

親の注釈への参照を解決します。

オプション parentId

parentId: undefined | string

ポップアップ注釈の親の注釈ID。

オプション popupId

popupId: undefined | string

ポップアップID。

printableFlag

printableFlag: boolean

注釈を印刷できるかどうかを指定します。

rect

rect: number[]

注釈の境界四角形：[x1、y1、x2、y2]。（0、0）はページの左下隅です。

redacted

redacted: boolean

現在の注釈が墨消し注釈かどうかを示します。墨消し注釈は、保存後にドキュメントから削除されます。

redactedBy

redactedBy: string

現在の注釈を墨消しをするために使用された墨消し注釈の ID。

referenceAnnotationId

referenceAnnotationId: string

この注釈が属する親の注釈ID （「返信」値）。

referenceType

referenceType: "R" | "Group"

R -この注釈は、referenceAnnotationIdフィールドで指定された親の注釈への応答です。 Group -注釈は、referenceAnnotationIdフィールドで指定された親の注釈とグループ化する必要があります。

オプション rotate

rotate: undefined | number

注釈がページに対して回転する度の数。

オプション sharedChanges

sharedChanges: undefined | {}

この注釈を変更したユーザーに関する情報を含むハッシュオブジェクト。キー - ユーザー名値 - 変更が追加されたときのUNIXUTCタイムスタンプ。

オプション state

state: AnnotationMarkedStateType | AnnotationReviewStateType

PDF 1.5以降、注釈は作成者固有の状態に関連付けられることがあります。状態は、注釈自体では指定されませんが、「IRT」（「返信」）エントリを使用して元の注釈を参照する別のテキスト注釈で指定されます。

オプション stateModel

stateModel: AnnotationStateModel

状態に対応する状態モデル。

subject

subject: string

注釈によって対処されている主題の簡単な説明を表すテキスト。「subject」はメタ情報プロパティであり、注釈をグループ化、並べ替え、またはフィルタするに使用できます。

subtype

subtype: AnnotationTypeName

注釈のサブタイプ。可能な値は次のとおりです。「Text」、「Link」、「FreeText」、「Line」、「Square」、「Circle」、「Polygon」、「PolyLine」、「Highlight」、「Underline」、「Squiggly」、「Strikeout」、「Stamp」、「Caret」、「Ink」、「Popup」、「FileAttachment」、「Sound」、「Movie」、「Widget」、「Screen」、「PrinterMark」、「TrapNet」、「WaterMark」、「Redact」、「Signature」、「ThreadBead」、「RadioButton」、「Checkbox」、「PushButton」、「Choice」および「TextWidget」。

textAlignment

textAlignment: TextAlignmentType

テキストの配置。

title

title: string

ポップアップを開いたときに注釈のポップアップのタイトルバーに表示されるテキストラベル。