ReplyToolSettings 型の別名

ReplyToolSettings: { allowAddNote?: boolean; allowAddReply?: boolean; allowAddReplyOtherUser?: boolean; allowChangeOtherUser?: boolean; allowChangeUserName?: boolean; allowDelete?: boolean; allowDeleteOtherUser?: boolean; allowStatus?: boolean; allowStatusOtherUser?: boolean; annotationFilter?: ((annotation: AnnotationBase, index: number, array: AnnotationBase[]) => undefined | boolean); annotationFocusColor?: string; autoExpandOnCommentAdd?: boolean; dateFormat?: string; readOnly?: boolean; useColoredIcons?: boolean; useRelativeDates?: boolean }

返信ツールの設定。

型宣言

  • オプション allowAddNote?: boolean

    メモを追加できます。

  • オプション allowAddReply?: boolean

    返信を追加できます。

  • オプション allowAddReplyOtherUser?: boolean

    他のユーザーが作成したメモに返信を追加できます。

  • オプション allowChangeOtherUser?: boolean

    他のユーザーが作成したメモを変更できます。

  • オプション allowChangeUserName?: boolean

    ユーザー名の変更を許可します。

  • オプション allowDelete?: boolean

    メモや返信を削除できます。

  • オプション allowDeleteOtherUser?: boolean

    他のユーザーが作成したメモや返信を削除できます。

  • オプション allowStatus?: boolean

    メモや返信のステータスを設定できます。

  • オプション allowStatusOtherUser?: boolean

    他のユーザーが作成したメモや返信にステータスを設定できます。

  • オプション annotationFilter?: ((annotation: AnnotationBase, index: number, array: AnnotationBase[]) => undefined | boolean)
      • (annotation: AnnotationBase, index: number, array: AnnotationBase[]): undefined | boolean
      • 返信ツールに表示する注釈を決定するオプションのフィルター関数。関数が true を返す場合、注釈が表示されます。false を返す場合、注釈は非表示になります。指定されていない場合は、デフォルトの動作が使用されます。

        戻り値

        注釈を表示する場合は true、非表示にする場合は false です。

        サンプル

        // 返信ツールにテキスト注釈のみを表示する。
        var viewer = new DsPdfViewer("#root", {
        replyTool: {
        annotationFilter: (annotation) => annotation.annotationType === 1 // AnnotationType.TEXT
        }
        });

        パラメータ

        • annotation: AnnotationBase

          評価される注釈。

        • index: number

          配列内の注釈のインデックス。

        • array: AnnotationBase[]

          注釈の完全なリスト。

        戻り値 undefined | boolean

  • オプション annotationFocusColor?: string

    返信ツール内のコメント リストで選択されたときに、PDF ページ上の注釈を一時的に強調表示するために使用される色を定義します。

    プロパティ

    16 進形式のハイライト カラー。この設定は、color パラメータが明示的に指定されていない場合、showAnnotationFocusOutline メソッドでも使用されます。

    サンプル

    var viewer = new DsPdfViewer("#root", { replyTool: { annotationFocusColor: "blue" } });
  • オプション autoExpandOnCommentAdd?: boolean

    コンテキスト メニューからコメントが追加されたときに、返信ツールが自動的に展開されるかどうかを制御します。

    プロパティ

    自動拡張を有効にするには true に設定し、無効にするには false に設定します。

    サンプル

    // 返信ツールの自動展開を無効にします。
    var viewer = new DsPdfViewer("#root", { replyTool: { autoExpandOnCommentAdd: false } });
  • オプション dateFormat?: string

    コメント ヘッダー内の絶対日付のカスタム形式を指定します。

    プロパティ

    HH:MM"] - 絶対日付を表示するときに使用する形式。useRelativeDatestrue の場合は無視されます。

    サンプル

    // 絶対日付にはカスタム形式を使用します。
    var viewer = new DsPdfViewer("#root", { replyTool: { useRelativeDates: false, dateFormat: "dd.mm.yyyy HH:MM" } });
  • オプション readOnly?: boolean

    読み取り専用モードを有効にして、変更を防止します。

  • オプション useColoredIcons?: boolean

    true に設定すると、コメント アイコンは注釈で使用されている色で塗りつぶされます。

  • オプション useRelativeDates?: boolean

    コメント ヘッダーで相対日付の使用を有効にします。

    プロパティ

    True:: 相対日付を表示します (例: 「5 分前」)。

    • false: 絶対日付を表示します。

    サンプル

    // 相対日付を有効にします (デフォルトの動作)。
    var viewer = new DsPdfViewer("#root", { replyTool: { useRelativeDates: true } });

    // Disable relative dates.
    var viewer = new DsPdfViewer("#root", { replyTool: { useRelativeDates: false } });