FreeTextAnnotation クラス

FreeText注釈。

階層

プロパティ

sharedChanges?: { [userName: string]: number }

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

型宣言

  • [userName: string]: number
id: string

注釈ID。

annotationName: string

注釈名(NMエントリ)。

convertToContent?: boolean

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

display?: "visible" | "hidden"

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

orderIndex: number

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

annotationType: AnnotationTypeCode

注釈の種類。

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

注釈の境界線スタイル。

型宣言

  • width: number

    境界線の幅。

  • style: number

    境界線のスタイル。設定できる値は、1 - 実線 (デフォルト)または 2 - 破線です。

  • オプション dashArray?: number[]

    境界線のダッシュパターン。 境界線のスタイルが破線の場合に使用されます。

  • horizontalCornerRadius: number
  • verticalCornerRadius: number
appearanceColor?: string

外観の色。

color?: string

注釈の色。

contents?: string

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

opacity?: number

注釈の不透明度。

textAlignment: TextAlignmentType

テキストの配置。

注釈のサブタイプ。可能な値は次のとおりです。「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」。

title: string

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

subject: string

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

rect: number[]

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

printableFlag: boolean

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

creationDate: string

作成日。

modificationDate: string

変更日。

parentId?: string

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

parentAnnotation?: AnnotationBase

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

referenceType: "R" | "Group"

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

referenceAnnotationId: string

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

rotate?: number

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

irtAnnotations?: AnnotationBase[]

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

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

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

invisibleFlag: boolean

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

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');
redactedBy: string

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

redacted: boolean

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

gcProps?: GcProps

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

hasPopup: boolean

注釈にポップアップ注釈が関連付けられるかどうかを示します。

popupId: string

ポップアップ注釈の識別子。

fontSize: number

フォントのサイズ。

fontName: string

フォント名。利用可能な標準フォント名は、'Helv' (Helvetica)、 'HelveticaItalic' (Helvetica Italic)、 'HelveticaBold' (Helvetica Bold)、 'HelveticaBoldItalic' (Helvetica Bold Italic)、 'TimesRegular' (Times Roman)、 'TimesItalic' (Times Roman Italic)、 'TimesBold' (Times Roman Bold)、 'TimesBoldItalic' (Times Roman Bold Italic)、 'CourierRegular' (Courier)、 'CourierItalic' (Courier Italic)、 'CourierBold' (Courier Bold)、 'CourierBoldItalic' (Courier Bold Italic)および 'Symbol' (Text symbol letters) です。

既定値

「Helvetica」