SignToolSettings 型の別名

型宣言

• オプション afterAdd?: ((result: { annotation: AnnotationBase; pageIndex: number }) => void)

  • • (result: { annotation: AnnotationBase; pageIndex: number }): void

    • afterAddイベントハンドラーは、注釈が追加され、署名ダイアログが閉じられたときに呼び出されます。

      サンプル

      var viewer = new DsPdfViewer("#root");
      viewer.options.signTool = {
       afterAdd: function() {
       // ここにコードを入れてください。
       return true;
       },
      };

      サンプル

      // 結果注釈のタイトルを更新し、注釈をコンテンツに変換します。
      var viewer = new DsPdfViewer(selector, {
       supportApi: {
       apiUrl: 'http://127.0.0.1:5001/support-api/gc-pdf-viewer',
       webSocketUrl: false
       },
       signTool: {
       afterAdd: function(result) {
       var annotation = result.annotation;
       annotation.title = 'New Title';
       annotation.convertToContent = true;
       viewer.updateAnnotation(result.pageIndex, annotation);
       return true;
       }
       }
      });

      パラメータ

      • result: { annotation: AnnotationBase; pageIndex: number }

        • annotation: AnnotationBase

        • pageIndex: number

      戻り値 void

• オプション afterShow?: ((signatureDialog: any) => void)

  • • (signatureDialog: any): void

    • ダイアログが表示された後、afterShowイベントハンドラーが呼び出されます。

      サンプル

      var viewer = new DsPdfViewer("#root");
      viewer.options.signTool = {
       afterShow: function() {
       alert('The dialog is shown.');
       },
      };

      パラメータ

      • signatureDialog: any

      戻り値 void

• オプション autoResizeCanvas?: boolean

  ウィンドウサイズが小さい場合にウィンドウに合わせて縮小するように、キャンバスサイズを自動的に調整します。

  既定値

  「true」

• オプション beforeAdd?: ((activeTool: any, signatureDialog: any) => boolean)

  • • (activeTool: any, signatureDialog: any): boolean

    • [追加]ボタンがクリックされると、beforeAddイベントハンドラーが呼び出されます。 デフォルトの追加アクションをキャンセルする場合、falseを返します。

      サンプル

      var viewer = new DsPdfViewer("#root");
      viewer.options.signTool = {
       beforeAdd: function() {
       // Put your code here.
       return true;
       },
      };

      パラメータ

      • activeTool: any

      • signatureDialog: any

      戻り値 boolean

• オプション beforeHide?: ((signatureDialog: any) => boolean)

  • • (signatureDialog: any): boolean

    • beforeHideイベントハンドラーは、ダイアログが閉じられる前に呼び出されます。 ダイアログが閉じないようにする場合、falseを返します。

      サンプル

      viewer.options.signTool = {
       subject: "subject1",
       beforeHide: function (dialog) {
       // ダイアログが非表示になるときに、カスタムコードを実行できます。
       console.log("dialog subject is " + dialog.subject);
       }
      };

      サンプル

      var viewer = new DsPdfViewer("#root");
      viewer.options.signTool = {
       beforeHide: function() {
       // ダイアログが閉じないようにするには、falseを返します。
       return false;
       },
      };

      パラメータ

      • signatureDialog: any

      戻り値 boolean

• オプション beforeShow?: ((signatureDialog: any) => boolean)

  • • (signatureDialog: any): boolean

    • beforeShowイベントハンドラーは、ダイアログが表示される前に呼び出されます。 ダイアログが表示されないようにする場合、falseを返します。

      サンプル

      var viewer = new DsPdfViewer("#root");
      viewer.options.signTool = {
       beforeShow: function() {
       // ダイアログの表示をキャンセルするには、falseを返します。
       return false;
       },
      };

      パラメータ

      • signatureDialog: any

      戻り値 boolean

• オプション bold?: boolean

  [Type]タブの太字スタイル。

  既定値

  false

• オプション canvasSize?: { height: number; width: number }

  キャンバスのサイズ（ピクセル単位）。

  既定値

  • height: number

  • width: number

• オプション convertToContent?: boolean

  結果スタンプをコンテンツに変換します。

  既定値

  false

  サンプル

  var viewer = new DsPdfViewer("#root", signTool: { convertToContent: true });

• オプション destinationScale?: number

  キャンバススケールの目標値。注釈の境界は、この値を使用してスケーリングされます。 たとえば、destinationScaleとcanvasSizeを「0.5」と「400/200」に設定する場合、注釈のサイズは「200/100」になります。

  既定値

  0.5

• オプション dialogLocation?: "Center" | "Top" | "Right" | "Bottom" | "Left" | { x: number; y: number }

  ウィンドウの長方形内にダイアログの位置。 原点は左上です。

  既定値

  「Center」

• オプション fontName?: string

  [Type]タブに使用されるデフォルトのフォント名。

  既定値

  「Brush Script MT」

• オプション fontNames?: string[]

  使用可能なフォント名の配列。

  既定値

  ['Arial', 'Verdana', 'Helvetica', 'Tahoma', 'Trebuchet MS', 'Times New Roman', 'Georgia', 'Garamond', 'Courier New', 'Brush Script MT']

• オプション fontSize?: number

  [Type]タブに使用されるデフォルトのフォントサイズ。

  既定値

  48

• オプション hasImage?: boolean

  trueの場合、署名ツールは[Image]タブのローカルストレージから画像をロードします。

  既定値

  false

  サンプル

  // ビューワを作成します。
  var viewer = new DsPdfViewer({ userName: 'John', signTool: { hasImage: true, saveSignature: true, selectedTab: 'Image', tabs: ['Image'] } });
  // [Image]タブで使用する画像を保存します。
  viewer.signToolStorage.saveImage('Image', document.querySelector('img'));

• オプション hideDialogFooter?: boolean

  ダイアログのフッタを非表示にするかどうかを指定します。

  既定値

  false

• オプション hideDialogTitle?: boolean

  ダイアログのタイトルを非表示にするかどうかを指定します。

  既定値

  false

• オプション hideSaveSignature?: boolean

  [署名を保存]ボタンを非表示にするかどうかを指定します。

  既定値

  false

• オプション hideTabs?: boolean

  タブのボタンを非表示にするかどうかを指定します。

  既定値

  false

• オプション hideToolbar?: boolean

  入力および描画スタイルをカスタマイズするに使用できるツールバーを非表示にするかどうかを指定します。

  既定値

  false

• オプション italic?: boolean

  [Type]タブの斜体スタイル。

  既定値

  true

• オプション location?: "Center" | "Top" | "Right" | "Bottom" | "Left" | "TopLeft" | "TopRight" | "BottomRight" | "BottomLeft" | { x: number; y: number }

  ページに注釈の結果の位置。メモ：（{x、y}値を使用して）正確な位置を指定すると、原点は左下隅になります。

  既定値

  「BottomRight」

• オプション pageIndex?: number

  宛先ページのインデックス。

  既定値

  デフォルトは、表示されているページインデックスです。

• オプション penColor?: string

  ペンの色。

  既定値

  #000000

  サンプル

   options.signTool = {
   penColor: '#00ff00'
   };

• オプション penWidth?: number

  ペンの幅。

  既定値

  2

• オプション ruler?: { Draw: RulerLine[] | false; Image: RulerLine[] | false; Type: RulerLine[] | false } | false

  キャンバスルーラーのカスタマイズ。

  サンプル

  // すべてのルーラーを非表示にします。
  viewer.options.signTool = { ruler: false };

  サンプル

  // ［Draw］タブのルーラーを非表示にします。
  viewer.options.signTool = { ruler: { Draw: false } };

  サンプル

  // [Draw]タブのカスタムルーラーを定義します。
  viewer.options.signTool = {
   ruler: {
   Draw: [{ color: "#ff0000", size: 5, type: "dashed", position: 50 },
         { color: "#ff00ff", size: 2, type: "solid", position: 80 }] 
    } 
  };

• オプション saveSignature?: boolean

  署名データを後で使用するためにブラウザのローカルストレージに保存する必要があるかどうかを示します。保存されたデータはアクティブユーザーが所有され、currentUserNameプロパティを使用して設定できます。

  既定値

  false

• オプション selectedTab?: "Type" | "Draw" | "Image"

  最初に選択されたタブ。

  既定値

  デフォルトは「Draw」です。

  サンプル

  var viewer = new DsPdfViewer("#host", {
   signTool: { selectedTab: 'Type' }
  });

• オプション subject?: string

  出力された注釈の件名。

  既定値

  空の文字列

• オプション tabs?: ("Type" | "Draw" | "Image")[]

  使用可能なタブの配列。タブの順序は保持されます。可能な値は、「Type」、「Draw」、「Image」です。

  既定値

  ['Type', 'Draw', 'Image']

• オプション text?: string

  [Type]タブに使用されるデフォルトのテキスト。

• オプション textColor?: string

  テキストの色。

  既定値

  #000000

  サンプル

   options.signTool = {
   textColor: '#00ff00'
   };

• オプション title?: string

  ダイアログのタイトル。

  既定値

  「署名の追加」

  サンプル

   options.signTool = {
   title: 'Signature'
   };