オプション
すべて
  • Public
  • Public/Protected
  • すべて
メニュー

GcPdfViewer クラス

PDFビューワのコントロール。.

階層

  • ReportViewer
    • GcPdfViewer

実装

  • IViewerHost

インデックス

コンストラクタ

プロパティ

アクセサー

メソッド

コンストラクタ

コンストラクタ

  • GcPDFViewer コンストラクタ。.

    パラメータ

    • element: HTMLElement | string

      ルートコンテナ要素またはルートコンテナ要素の選択に使用されるセレクタパターン。

    • 既定値 options: Partial<ViewerOptions> = {}

      ビューワのオプション。詳細については、ViewerOptions を参照してください。

    戻り値 GcPdfViewer

プロパティ

Static LicenseKey

LicenseKey: string

製品のライセンスキー。

サンプル
<script>
    // ライセンスキーを追加します 
    GcPdfViewer.LicenseKey = 'XXX'; 
    // コードを追加します
    const viewer = new GcPdfViewer("#viewer"); 
   viewer.addDefaultPanels(); 
</script>

アクセサー

activatedEditorMode

  • get activatedEditorMode(): "SecondBar" | "FormEditor" | "AnnotationEdtor" | "Any" | "" | undefined
  • アクティブ化されたエディタモード名。

    戻り値 "SecondBar" | "FormEditor" | "AnnotationEdtor" | "Any" | "" | undefined

annotations

  • get annotations(): Promise<{ annotations: AnnotationBase[]; pageIndex: number }[]>
  • ドキュメント内のすべての注釈を取得します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.addDefaultPanels(); 
    viewer.onAfterOpen.register(function() { 
      viewer.annotations.then(function(data) { 
        for(var i = 0; i < data.length; i++){ 
          var pageAnnotationsData = data[i]; 
          var pageIndex = pageAnnotationsData.pageIndex; 
          var annotations = pageAnnotationsData.annotations; 
          console.log("Page with index " + pageIndex + " contains " + annotations.length + " annotation(s)"); 
        } 
      }); 
    }); 
    viewer.open('Test.pdf');

    戻り値 Promise<{ annotations: AnnotationBase[]; pageIndex: number }[]>

beforeUnloadConfirmation

  • get beforeUnloadConfirmation(): boolean
  • set beforeUnloadConfirmation(enable: boolean): void
  • ドキュメントが変更されたときにページから出るかどうかをユーザーから確認します。SupportApiが必要です。

    サンプル
    var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' } ); 
    viewer.addDefaultPanels(); 
    viewer.addAnnotationEditorPanel(); 
    viewer.addFormEditorPanel(); 
    viewer.beforeUnloadConfirmation = true;

    戻り値 boolean

  • ドキュメントが変更されたときにページから出るかどうかをユーザーから確認します。SupportApiが必要です。

    サンプル
    var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' } ); 
    viewer.addDefaultPanels(); 
    viewer.addAnnotationEditorPanel(); 
    viewer.addFormEditorPanel(); 
    viewer.beforeUnloadConfirmation = true;

    パラメータ

    • enable: boolean

    戻り値 void

canEditDocument

  • get canEditDocument(): boolean
  • SupportApiを使用して開いたドキュメントを編集できるかどうかを示します。SupportApiが必要です。

    サンプル
    if(viewer.canEditDocument) { 
       alert("ドキュメントの編集機能が有効になっています。"); 
    } else { 
       alert("ドキュメントの編集機能が無効になっています。"); 
    }

    戻り値 boolean

currentUserName

  • get currentUserName(): string
  • set currentUserName(userName: string): void
  • 現在のユーザー名を指定します。このプロパティは、注釈エディタによって「作成者」フィールドのデフォルト値として使用されます。

    サンプル
    viewer.currentUserName = "John";
    サンプル
    alert("現在のユーザー名は " + viewer.currentUserName);

    戻り値 string

  • 現在のユーザー名を指定します。このプロパティは、注釈エディタによって「作成者」フィールドのデフォルト値として使用されます。メモ:現在のユーザー名はブラウザのローカルストレージに保存され、userNameオプションが設定されない場合、次のページのリロードで使用されます。

    サンプル
    viewer.currentUserName = "John";
    サンプル
    alert("現在のユーザー名は " + viewer.currentUserName);

    パラメータ

    • userName: string

    戻り値 void

dataLoader

  • get dataLoader(): GcPdfViewerDataLoader
  • PDFドキュメントのメタデータのローダー。 一部のサイドバーパネルで使用されます。

    戻り値 GcPdfViewerDataLoader

editMode

  • 注釈エディタまたはフォームエディタ用に選択された編集ツールを示します。SupportApiが必要です。

    サンプル
    // レイアウトモードを「注釈エディタ」に設定します。 
    viewer.layoutMode = 1; 
    // 編集モードを「正方形」に設定します。 
    viewer.editMode = 4;

    戻り値 EditMode

  • 注釈エディタまたはフォームエディタ用に選択された編集ツールを示します。SupportApiが必要です。

    サンプル
    // レイアウトモードを「注釈エディタ」に設定します。 
    viewer.layoutMode = 1; 
    // 編集モードを「正方形」に設定します。 
    viewer.editMode = 4;

    パラメータ

    戻り値 void

fileData

  • get fileData(): Uint8Array | null
  • ファイルデータを取得します。 keepFileDataオプションがtrueに設定する場合に使用できます。

    サンプル
    var viewer = new GcPdfViewer('#root', { keepFileData: true }); 
    viewer.open('Test.pdf'); 
    viewer.onAfterOpen.register(function() { 
       var pdfFileData = viewer.fileData; 
    });

    戻り値 Uint8Array | null

fileName

  • get fileName(): string
  • ドキュメントを開くために使用されたファイル名を取得します。 ファイル名は次のように決定されます。

    • [ファイルを開く]ダイアログを使用してローカルファイルを開いた場合、ローカルファイル名を返します。
    • 「newDocument」メソッドを使用して新しいファイルが作成された場合、そのメソッドに渡された引数を返します。
    • options.friendlyFileNameが空でない場合、その値を返します。
    • 「open」メソッドに渡されたURLから生成された名前を返します。
    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       alert("ドキュメントが開かれ、ファイル名は " + viewer.fileName); 
    }); 
    viewer.open('MyDocuments/Test.pdf');

    戻り値 string

fileUrl

  • get fileUrl(): string
  • ドキュメントを開くに使用されたURLを取得します。ドキュメントがバイナリデータから開かれたときに空の文字列を返します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       alert("ドキュメントが開かれ、ファイルのURLは " + viewer.fileUrl); 
    }); 
    viewer.open('MyDocuments/Test.pdf');

    戻り値 string

fingerprint

  • get fingerprint(): string
  • 一意のドキュメント識別子。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       alert(「ドキュメントを開きました。一意のドキュメント識別子は"+ viewer.fingerprint); 
    }); 
    viewer.open('Test.pdf');

    戻り値 string

gcPdfVersion

  • get gcPdfVersion(): string
  • SupportApiで使用されるGcPDFライブラリのバージョンを取得します。

    戻り値 string

hasChanges

  • get hasChanges(): boolean
  • ドキュメントがユーザーによって変更されたかどうかを示します。

    サンプル
    if(viewer.hasChanges) { 
       alert("ドキュメントが変更されました。"); 
    }

    戻り値 boolean

hasCopyData

  • get hasCopyData(): boolean
  • コピーしたバッファにデータが含まれるかどうかを示します。

    サンプル
    if(viewer.hasCopyData) { 
       viewer.execPasteAction(); 
    }

    戻り値 boolean

hasDocument

  • get hasDocument(): boolean
  • ドキュメントがビューにロードされるかどうかを示します。

    サンプル
    if(!viewer.hasDocument) { 
       viewer.open("sample.pdf"); 
    }

    戻り値 boolean

hasForm

  • get hasForm(): boolean
  • アクティブなドキュメントにフォームフィールドがあるかどうかを示す値を取得します。

    サンプル
    if(viewer.hasForm) { 
       viewer.showFormFiller(); 
    }

    戻り値 boolean

hasPersistentConnection

  • get hasPersistentConnection(): boolean
  • ビューワがサーバーに永続的な接続があるかどうかを示す値を取得します。

    ```javascript if(viewer.hasPersistentConnection) { viewer.listSharedDocuments().then(function(result) {

    }); }

    戻り値 boolean

hasRedoChanges

  • get hasRedoChanges(): boolean
  • PDFビューワがドキュメントの変更をやり直すことができるかどうかを示す値を取得します。SupportApiが必要です。

    サンプル
    if(viewer.hasRedoChanges) { 
       viewer.redoChanges(); 
    }

    戻り値 boolean

hasReplyTool

  • get hasReplyTool(): boolean
  • 返信ツールが追加されるかどうかを示します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    if(viewer.hasReplyTool) { 
       alert("返信ツールはビューワに追加されません。"); 
    } else { 
       alert("返信ツールはビューワに追加されます。"); 
    } 
    viewer.open('Test.pdf');

    戻り値 boolean

hasUndoChanges

  • get hasUndoChanges(): boolean
  • PDFビューワがドキュメントの変更を元に戻すことができるかどうかを示す値を取得します。SupportApiが必要です。

    サンプル
    if(viewer.hasUndoChanges) { 
       viewer.undoChanges(); 
    }

    戻り値 boolean

hideAnnotations

  • get hideAnnotations(): boolean
  • set hideAnnotations(hide: boolean): void
  • 注釈レイヤを非表示にするかどうかを決定します。

    サンプル
    // 注釈を非表示にします。 
    viewer.hideAnnotations = true;

    戻り値 boolean

  • 注釈レイヤを非表示にするかどうかを決定します。

    サンプル
    // 注釈を非表示にします。 
    viewer.hideAnnotations = true;

    パラメータ

    • hide: boolean

    戻り値 void

isDocumentShared

  • get isDocumentShared(): boolean
  • アクティブなドキュメントが共有モードで開いているかどうかを示す値を取得します。 SupportApiが必要です。

    サンプル
    if(viewer.isDocumentShared) { 
       alert("ドキュメントは共有モードで開かれています。"); 
    }

    戻り値 boolean

isEditModeSticked

  • get isEditModeSticked(): boolean
  • アクティブな編集モードがユーザーによって固定される場合はtrueを返します。アクティブな編集ボタンのstickyBehaviorが有効になって、ボタンがチェックされることを示します。詳細については、toolbarLayout.stickyBehaviorプロパティを参照します。

    戻り値 boolean

isInEditorMode

  • get isInEditorMode(): boolean
  • エディタモードが現在アクティブであるかどうかを示す値を取得します。

    サンプル
    let isInEditorMode = viewer.isInEditorMode;
    サンプル
    // 編集モードの開始/終了を検出します。 
    var isEdit = false; 
    viewer.onViewerStateChange.register(function () { 
        if (viewer.isInEditorMode !== isEdit) { 
            isEdit = viewer.isInEditorMode; 
            console.log(isEdit ? "Editor Mode activated." : "Editor Mode deactivated."); 
        } 
    });

    戻り値 boolean

isUpdating

  • get isUpdating(): boolean
  • @see:beginUpdateへの呼び出しによって通知が中断された場合、trueを返します。

    サンプル

    var isUpdatingFlag = viewer.isUpdating;

    戻り値 boolean

layoutMode

  • レイアウトモードを取得または設定します(0 - ビューワ、1 - 注釈エディタ、または2 - フォームエディタ)。

    既定値

    0

    サンプル
    // レイアウトモードを「フォームエディタ」に設定します。 
    viewer.layoutMode = 2;

    戻り値 LayoutMode

  • レイアウトモードを取得または設定します(0 - ビューワ、1 - 注釈エディタ、または2 - フォームエディタ)。

    既定値

    0

    サンプル
    // レイアウトモードを「フォームエディタ」に設定します。 
    viewer.layoutMode = 2;

    パラメータ

    戻り値 void

leftSidebar

  • 左側のサイドバーのAPI。

    サンプル
    viewer.leftSidebar.hide();

    戻り値 LeftSidebar

logLevel

  • 現在のログレベルを取得します。使用可能なログレベルは、「なし」、「重大」、「エラー」、「警告」、「情報」、「デバッグ」、「トレース」です。デフォルトの値は「なし」です。

    戻り値 LogLevel

  • 現在のログレベルを設定します。使用可能なログレベルは、「なし」、「重大」、「エラー」、「警告」、「情報」、「デバッグ」、「トレース」です。デフォルトの値は「なし」です。

    パラメータ

    戻り値 void

modificationsState

  • アクティブなドキュメントの変更状態を取得します。SupportApiが必要です。

    サンプル
    var modificationsState = viewer.modificationsState; 
    console.log(modificationsState);

    戻り値 ModificationsState

onAfterAddAnnotation

  • onAfterAddAnnotation イベント。

    サンプル
    viewer.onAfterAddAnnotation.register(function(args) { 
        console.log(args); 
    });

    戻り値 EventFan<AfterAddAnnotationEventArgs>

onAfterOpen

  • ユーザーがビューワのテーマを変更したときに発生するイベント。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       alert("ドキュメントを開きました。"); 
    }); 
    viewer.open('Test.pdf');

    戻り値 EventFan<AfterOpenEventArgs>

onAfterRemoveAnnotation

  • onAfterRemoveAnnotation イベント。

    サンプル
    viewer.onAfterRemoveAnnotation.register(function(args) { 
        console.log(args); 
    });

    戻り値 EventFan<AfterRemoveAnnotationEventArgs>

onAfterUpdateAnnotation

  • onAfterUpdateAnnotation イベント。

    サンプル
    viewer.onAfterUpdateAnnotation.register(function(args) { 
        console.log(args); 
    });

    戻り値 EventFan<AfterUpdateAnnotationEventArgs>

onBeforeAddAnnotation

  • onBeforeAddAnnotation イベント。このイベントはキャンセルすることができます。

    サンプル
    viewer.onBeforeAddAnnotation.register(function(args) { 
       console.log(args); 
       args.cancel = true; // イベントをキャンセルするには、キャンセルフラグを設定します。 
    });

    戻り値 EventFan<BeforeAddAnnotationEventArgs>

onBeforeOpen

  • ドキュメントを開く直前に発生します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onBeforeOpen.register(function(args) { 
       alert("A new document will be opened,\n payload type(binary or URL): " + args.type +",\n payload(bytes or string): " + args.payload); 
    }); 
    viewer.open('Test.pdf');

    戻り値 EventFan<BeforeOpenEventArgs>

onBeforeRemoveAnnotation

  • onBeforeRemoveAnnotation イベント。このイベントはキャンセルすることができます。

    viewer.onBeforeRemoveAnnotation.register(function(args) { 
       console.log(args); 
       args.cancel = true; // イベントをキャンセルするには、キャンセルフラグを設定します。 
    });

    戻り値 EventFan<BeforeRemoveAnnotationEventArgs>

onBeforeUpdateAnnotation

  • onBeforeUpdateAnnotation イベント。このイベントはキャンセルすることができます。

    viewer.onBeforeUpdateAnnotation.register(function(args) { 
       console.log(args); 
       args.cancel = true; // イベントをキャンセルするには、キャンセルフラグを設定します。 
    });

    戻り値 EventFan<BeforeUpdateAnnotationEventArgs>

onError

  • エラーを示すイベント。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.addDefaultPanels(); 
    viewer.onError.register(handleError); 
    viewer.open('Test.pdf'); 
    
    function handleError(eventArgs) { 
        var message = eventArgs.message; 
        if (message.indexOf("無効なPDF構造") !== -1) { 
            alert('PDFドキュメントが壊れているため、PDFドキュメントを読み込めません。'); 
        } else { 
            alert('予期しないエラー: ' + message); 
        } 
    }

    戻り値 EventFan<ErrorEventArgs>

onThemeChanged

  • ビューワのテーマがユーザーによって変更されたときに発生します。

    サンプル
    var viewer = new GcPdfViewer(selector, { 
        requireTheme: localStorage.getItem('demo_theme') || 'viewer' 
    }); 
    viewer.addDefaultPanels(); 
    viewer.onThemeChanged.register(function(args) { 
      localStorage.setItem('demo_theme', args.theme); 
    });

    戻り値 EventFan<AfterOpenEventArgs>

optionalContentConfig

  • デフォルトのオプションのコンテンツ構成。オプションのコンテンツは、動的に表示または非表示にするグラフィックのコレクションです。

    サンプル
    // optionalContentConfigプロパティを使用して、使用可能なすべてのレイヤーに関する情報を印刷します。 
    const config = await viewer.optionalContentConfig; 
    console.table(config.getGroups());
    サンプル
    const config = await viewer.optionalContentConfig; 
    // 「13R」IDのオプションのコンテンツグループをオフにします。 
    config.setVisibility("13R", false); 
    // 表示されているページを再描画します。 
    viewer.repaint();

    戻り値 Promise<OptionalContentConfig>

options

  • ビューワのオプション。

    サンプル
    viewer.options.zoomByMouseWheel = { always: true }; 
    viewer.applyOptions();

    戻り値 Partial<ViewerOptions>

  • PDFビューワのオプション。

    サンプル
    viewer.options.zoomByMouseWheel = { always: true }; 
    viewer.applyOptions();

    パラメータ

    戻り値 void

pageCount

  • get pageCount(): number
  • ページ数を取得します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       alert(「ドキュメントを開きました。合計ページ数: " + viewer.pageCount); 
    }); 
    viewer.open('Test.pdf');

    戻り値 number

pageIndex

  • get pageIndex(): number
  • set pageIndex(val: number): void
  • アクティブなページのインデックスを取得または設定します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       // インデックス9のページに移動します。 
       viewer.pageIndex = 9; 
    }); 
    viewer.open('Test.pdf');

    戻り値 number

  • アクティブなページのインデックスを取得または設定します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    viewer.onAfterOpen.register(function() { 
       // インデックス9のページに移動します。 
       viewer.pageIndex = 9; 
    }); 
    viewer.open('Test.pdf');

    パラメータ

    • val: number

    戻り値 void

requiredSupportApiVersion

  • get requiredSupportApiVersion(): string
  • GcPdfViewerの現在のバージョンと互換性のある必要なSupportApiバージョンを取得します。

    戻り値 string

rightSidebar

  • 右側のサイドバーオブジェクトを取得します。このオブジェクトを使用して、右側のサイドバーを操作します。

    サンプル
    viewer.rightSidebar.show('expanded', 'reply-tool'); 
    viewer.rightSidebar.toggle(); 
    viewer.rightSidebar.hide(); 
    viewer.rightSidebar.expand(); 
    viewer.rightSidebar.collapse();

    戻り値 GcRightSidebar

rotation

  • get rotation(): number
  • set rotation(degrees: number): void
  • 回転を度単位で指定します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    // onAfterOpenイベントハンドラーを登録します。 
    viewer.onAfterOpen.register(function() { 
       // 時計回りに90度回転します。 
       viewer.rotation = 90; 
    }); 
    // ドキュメントを開きます。 
    viewer.open('Test.pdf');

    戻り値 number

  • 回転を度単位で指定します。

    サンプル
    var viewer = new GcPdfViewer('#root'); 
    // onAfterOpenイベントハンドラーを登録します。 
    viewer.onAfterOpen.register(function() { 
       // 時計回りに90度回転します。 
       viewer.rotation = 90; 
    }); 
    // ドキュメントを開きます。 
    viewer.open('Test.pdf');

    パラメータ

    • degrees: number

    戻り値 void

scrollView

  • get scrollView(): HTMLElement
  • スクロールビューを取得します。メモ:左スクロールの位置はビューワによって自動的に計算されます。したがって、左スクロールの位置を変更する必要はありません。

    サンプル
    // ドキュメントの先頭までスクロールします。 
    viewer.scrollView.scrollTop = 0;

    戻り値 HTMLElement

searcher

  • ドキュメント検索のインスタンス。現在の開いているドキュメントにテキストを検索します。

    サンプル
    // ドキュメントを開き、「wildlife」というテキストを見つけて、最初の結果を強調表示します。 
    async function loadPdfViewer(selector) { 
         var viewer = new GcPdfViewer(selector, { restoreViewStateOnLoad: false }); 
         viewer.addDefaultPanels(); 
         var afterOpenPromise = new Promise((resolve)=>{ viewer.onAfterOpen.register(()=>{ resolve(); }); }); 
         await viewer.open('wetlands.pdf'); 
         await afterOpenPromise; 
         var findOptions = { Text: 'wildlife' }; 
         var searchIterator = await viewer.searcher.search(findOptions); 
         var searchResult = await searchIterator.next(); 
      viewer.searcher.cancel(); 
      viewer.searcher.highlight(searchResult.value); 
    } 
    loadPdfViewer('#root');
    サンプル

    // ドキュメントを開き、「wildlife」というテキストを見つけて、検索結果をコンソールに出力します。

    async function loadPdfViewer(selector) { 
        var viewer = new GcPdfViewer(selector); 
         viewer.addDefaultPanels(); 
         await viewer.open('wetlands.pdf'); 
         await (new Promise((resolve)=>{ 
             viewer.onAfterOpen.register(()=>{ 
                 resolve(); 
             }); 
         })); 
         var findOptions = { 
             Text: 'wildlife', 
             MatchCase: true, 
             WholeWord: true, 
             StartsWith: false, 
             EndsWith: false, 
             Wildcards: false, 
             Proximity: false, 
             SearchBackward: false, 
             HighlightAll: true 
        }; 
        var searcher = viewer.searcher; 
        var searchIterator = await searcher.search(findOptions); 
        var resultsCount = 0; 
        var searchResult; 
        do { 
             searchResult = await searchIterator.next(); 
             if (searchResult.value) { 
                 // これは、結果メッセージまたは進行状況メッセージのいずれかです(ItemIndex <0) 
                 if(searchResult.value.ItemIndex >= 0) { 
                     console.log('次の検索結果: '); 
                     console.log(searchResult.value); 
                     resultsCount++; 
                 } else { 
                     const pageCount = _doc.pageCount.totalPageCount || _doc.pageCount.renderedSoFar; 
                     console.log('ページインデックスは ' + searchResult.value.PageIndex); 
                 } 
             } 
             else { 
                 console.log("検索が完了しました。"); 
                 break; 
             } 
         } 
         while(!searchResult.done); 
         console.log('Total results count is ' + resultsCount); 
    }

    戻り値 GcPdfSearcher

secondToolbar

secondToolbarLayout

  • get secondToolbarLayout(): SecondToolbarLayout
  • set secondToolbarLayout(layout: SecondToolbarLayout): void
  • 2番目のツールバーのレイアウト。 secondToolbarLayoutプロパティを使用して、利用可能なツールを構成します。

    既定値

    { "text-tools": ['edit-text', 'edit-free-text', 'edit-ink', '$split', 'edit-highlight', 'edit-underline', 'edit-squiggly', 'edit-strike-out', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "draw-tools": ['edit-square', 'edit-circle', 'edit-line', 'edit-polyline', 'edit-polygon', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "attachment-tools": ['edit-stamp', 'edit-file-attachment', 'edit-sign-tool', 'edit-sound', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "form-tools": ['edit-widget-tx-field', 'edit-widget-tx-password', 'edit-widget-tx-text-area', 'edit-widget-btn-checkbox', 'edit-widget-btn-radio', 'edit-widget-btn-push', 'edit-widget-ch-combo', 'edit-widget-ch-list-box', 'edit-widget-tx-comb', 'edit-widget-btn-submit', 'edit-widget-btn-reset', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "page-tools": ['new-document', 'new-page', 'delete-page', '$split', 'edit-undo', 'edit-redo'] }

    戻り値 SecondToolbarLayout

  • 2番目のツールバーのレイアウト。 secondToolbarLayoutプロパティを使用して、利用可能なツールを構成します。

    既定値

    { "text-tools": ['edit-text', 'edit-free-text', 'edit-ink', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "draw-tools": ['edit-square', 'edit-circle', 'edit-line', 'edit-polyline', 'edit-polygon', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "attachment-tools": ['edit-stamp', 'edit-file-attachment', 'edit-sign-tool', 'edit-sound', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "form-tools": ['edit-widget-tx-field', 'edit-widget-tx-password', 'edit-widget-tx-text-area', 'edit-widget-btn-checkbox', 'edit-widget-btn-radio', 'edit-widget-btn-push', 'edit-widget-ch-combo', 'edit-widget-ch-list-box', 'edit-widget-tx-comb', 'edit-widget-btn-submit', 'edit-widget-btn-reset', '$split', 'edit-undo', 'edit-redo', 'edit-erase', '$split', 'edit-redact', 'edit-redact-apply'], "page-tools": ['new-document', 'new-page', 'delete-page', '$split', 'edit-undo', 'edit-redo'] }

    パラメータ

    • layout: SecondToolbarLayout

    戻り値 void

signToolStorage

  • 現在の署名ツールの設定と画像を保存および取得するに使用できるデータストレージを返します。ストレージデータは現在のユーザー名、@see:currentUserNameプロパティに依存します。

    戻り値 SignToolStorage

storage

  • アクティブなドキュメントのデータストレージ。

    サンプル
    const fileData = viewer.storage.getItem(annotation.fileId);
    サンプル
    viewer.storage.setItem(fileId, bytes);
    サンプル

    ストレージ API を使用して、スタンプ注釈をプログラムで追加します。

    viewer.newDocument().then(function() { var xhr = new XMLHttpRequest(); xhr.open('GET', 'https://drive.grapecity.com/download?file=ExternalShare/GCImageViewer/DemoImages/jpg/alpamayo-small.jpg', true); xhr.responseType = 'arraybuffer'; xhr.onload = function(e) { var arrayBuffer = this.response; if (arrayBuffer) { // プログラムでスタンプ注釈を追加します。 viewer.storage.setItem("sample_file_id_1", new Uint8Array(arrayBuffer)); var pageSize = viewer.getPageSize(0); viewer.addAnnotation(0, {annotationType: 13, fileId: "sample_file_id_1", rect: [0, pageSize.height - 144, 144, pageSize.height]}); } }; xhr.send(); });

    戻り値 DataStorage

structureTree

  • 構造ツリーのデータ。

    サンプル
    const viewer = new GcPdfViewer(selector); 
    await viewer.open("sample.pdf"); 
    const structureTree = await viewer.structureTree; 
    if(structureTree) { 
       console.log(structureTree); 
    }

    戻り値 Promise<StructTreeNode[] | null>

    ページの構造ツリーを表す{@linkStructTreeNode []}オブジェクトで解決されるpromise。または、ページに構造ツリーが存在しない場合はnullです。

supportApi

  • get supportApi(): ISupportApi | null
  • SupportApiクライアントを取得します。SupportApiが必要です。

    サンプル
    var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' } ); 
    // サーバーに連絡して、SupportAPIバージョンを取得します。 
    viewer.serverVersion.then(function(ver) { 
        alert("The SupportApi version is " + ver); 
    });

    戻り値 ISupportApi | null

supportApiVersion

  • get supportApiVersion(): string
  • SupportApiの接続されたバージョンを取得します。

    戻り値 string

toolbarLayout

  • さまざまなビューワモード(viewer、annotationEditor、formEditor)のツールバーのレイアウトを定義します。

    説明

    viewerのツールバー項目の完全なリストは次のとおりです。

    'open', '$navigation', '$split', 'text-selection', 'pan', 'zoom', '$fullscreen', '$split', 'text-tools', 'draw-tools', 'attachment-tools', 'form-tools', 'page-tools', '$split', 'rotate', 'view-mode', 'theme-change', 'download', 'print', 'save', 'save-images', 'hide-annotations', 'form-filler', 'doc-title', 'doc-properties', 'about', 'share', 'single-page', 'continuous-view', '$history', '$mousemode', 'show-edit-tools', 'show-form-editor'

    annotationEditorのツールバー項目の完全なリストは次のとおりです。

    'edit-select', 'save', 'share', 'edit-text', 'edit-free-text', 'edit-ink', 'edit-square', 'edit-circle', 'edit-line', 'edit-polyline', 'edit-polygon', 'edit-stamp', 'edit-file-attachment', 'edit-sound', 'edit-link', 'edit-highlight', 'edit-underline', 'edit-squiggly', 'edit-strike-out'. 'edit-redact', 'edit-redact-apply', 'edit-erase', 'edit-undo', 'edit-redo', 'new-document', 'new-page', 'delete-page'

    formEditorのツールバー項目の完全なリストは次のとおりです。

    'edit-select-field', 'save', 'share', 'edit-widget-tx-field', 'edit-widget-tx-password', 'edit-widget-tx-text-area', 'edit-widget-btn-checkbox', 'edit-widget-btn-radio', 'edit-widget-btn-push', 'edit-widget-ch-combo', 'edit-widget-ch-list-box', 'edit-widget-tx-comb', 'edit-widget-btn-submit', 'edit-widget-btn-reset', 'edit-erase-field', 'edit-undo', 'edit-redo', 'new-document', 'new-page', 'delete-page'
    サンプル
    // ツールバーのレイアウトをカスタマイズします。 
    viewer.toolbarLayout.viewer.default = ["open", "save", "share"]; 
    viewer.toolbarLayout.annotationEditor.default = ["open", "save", "share", "$split", "new-document", "edit-ink", "edit-text"]; 
    viewer.toolbarLayout.formEditor.default = ["open", "save", "share", "$split", "edit-widget-tx-field", "edit-widget-tx-password"]; 
    viewer.applyToolbarLayout();
    サンプル
    // [開く]ボタンと[改訂]ボタンのみを表示します。 
    var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' }); 
    // 注釈エディタパネルを追加します。 
    viewer.addAnnotationEditorPanel(); 
    // ツールバーのレイアウトを変更します。 
    viewer.toolbarLayout = { viewer: { default: ["open", 'show-edit-tools']}, 
    annotationEditor: { default: ["open", 'edit-redact', 'edit-redact-apply']} }; 
    // 「注釈エディタ」レイアウトモードを有効にします。 
    viewer.layoutMode = 1;
    サンプル
    // 四角形、円、線のボタンを貼り付けます。 
    viewer.toolbarLayout.stickyBehavior = ["edit-square", "edit-circle", "edit-line"]; 
    viewer.applyToolbarLayout();

    戻り値 PdfToolbarLayout

  • さまざまなビューワモード(viewer、annotationEditor、formEditor)のツールバーのレイアウトを定義します。

    説明

    viewerのツールバー項目の完全なリストは次のとおりです。

    'text-selection', 'pan', 'open', 'save', 'share', 'download', 'print', 'rotate', 'theme-change', 'doc-title', 'view-mode', 'single-page', 'continuous-view', '$navigation' '$refresh', '$history', '$mousemode', 'zoom', '$fullscreen', '$split', 'show-edit-tools', 'show-form-editor'

    annotationEditorのツールバー項目の完全なリストは次のとおりです。

    'edit-select', 'save', 'share', 'edit-text', 'edit-free-text', 'edit-ink', 'edit-square', 'edit-circle', 'edit-line', 'edit-polyline', 'edit-polygon', 'edit-stamp', 'edit-file-attachment', 'edit-sound', 'edit-link', 'edit-highlight', 'edit-underline', 'edit-squiggly', 'edit-strike-out'. 'edit-redact', 'edit-redact-apply', 'edit-erase', 'edit-undo', 'edit-redo', 'new-document', 'new-page', 'delete-page'

    formEditorのツールバー項目の完全なリストは次のとおりです。

    'edit-select-field', 'save', 'share', 'edit-widget-tx-field', 'edit-widget-tx-password', 'edit-widget-tx-text-area', 'edit-widget-btn-checkbox', 'edit-widget-btn-radio', 'edit-widget-btn-push', 'edit-widget-ch-combo', 'edit-widget-ch-list-box', 'edit-widget-tx-comb', 'edit-widget-btn-submit', 'edit-widget-btn-reset', 'edit-erase-field', 'edit-undo', 'edit-redo', 'new-document', 'new-page', 'delete-page'
    サンプル
    // ツールバーのレイアウトをカスタマイズします。 
    viewer.toolbarLayout.viewer.default = ["open", "save", "share"]; 
    viewer.toolbarLayout.annotationEditor.default = ["open", "save", "share", "$split", "new-document", "edit-ink", "edit-text"]; 
    viewer.toolbarLayout.formEditor.default = ["open", "save", "share", "$split", "edit-widget-tx-field", "edit-widget-tx-password"]; 
    viewer.applyToolbarLayout();
    サンプル
    // [開く]ボタンと[改訂]ボタンのみを表示します。 
    var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' }); 
    // 注釈エディタパネルを追加します。 
    viewer.addAnnotationEditorPanel(); 
    // ツールバーのレイアウトを変更します。 
    viewer.toolbarLayout = { viewer: { default: ["open", 'show-edit-tools']}, 
    annotationEditor: { default: ["open", 'edit-redact', 'edit-redact-apply']} }; 
    // 「注釈エディタ」レイアウトモードを有効にします。 
    viewer.layoutMode = 1;

    パラメータ

    戻り値 void

undoCount

  • get undoCount(): number
  • 元に戻すスタックのレベル (コマンド) の数を取得します。 SupportApi が必要です。

    サンプル
    alert("元に戻すの数は" + viewer.undoCount);

    戻り値 number

undoIndex

  • get undoIndex(): number
  • 現在の元に戻すレベル (コマンド) のインデックスを取得します。これは、redoChanges() への次の呼び出しで実行される元に戻すコマンドです。 SupportApi が必要です。

    サンプル
    alert("現在の元に戻すのインデックスは" + viewer.undoIndex);

    戻り値 number

undoState

  • get undoState(): (0 | { changeName: UndoChangeName; data: any; selectedAnnotation: { annotation: AnnotationBase; pageIndex: number } | null })[]
  • 元に戻すストアの現在の状態。 このプロパティは読み取り専用であり、プログラムによってコレクションの要素を変更しないことに注意してください。 Undo API メソッドを使用して、ビューワのエディタの状態を変更します。 Undo API のプロパティは、hasUndoChanges、hasRedoChanges、undoIndex です。 undoCount Undo API メソッドは、undoChanges()、redoChanges() です。

    戻り値 (0 | { changeName: UndoChangeName; data: any; selectedAnnotation: { annotation: AnnotationBase; pageIndex: number } | null })[]

version

  • get version(): string
  • PDFビューワの現在のバージョンを返します。

    サンプル
    alert("PDFビューワのバージョンは " + viewer.version);

    戻り値 string

zoomMode

  • get zoomMode(): ZoomMode
  • set zoomMode(val: ZoomMode): void
  • 現在の拡大縮小モードを取得または設定します。指定できる値は「0 - Value」、「1 - PageWidth」および「2 - WholePage」。

    // 拡大縮小モードを「WholePage」に設定します。 
    viewer.zoomMode = 2;
    サンプル
    // 拡大縮小モードを「WholePage」に設定します。 
    viewer.zoomMode = 2;

    戻り値 ZoomMode

  • 現在の拡大縮小モードを取得または設定します。指定できる値は「0 - Value」、「1 - PageWidth」および「2 - WholePage」。

    サンプル
    // 拡大縮小モードを「WholePage」に設定します。 
    viewer.zoomMode = 2;

    パラメータ

    • val: ZoomMode

    戻り値 void

zoomValue

  • get zoomValue(): number
  • set zoomValue(val: number): void
  • 現在の拡大率のレベルを取得または設定します。

    サンプル
    // 拡大値を150%に設定します。 
    viewer.zoomValue = 150;

    戻り値 number

  • 現在の拡大率のレベルを取得または設定します。

    サンプル
    // 拡大値を150%に設定します。 
    viewer.zoomValue = 150;

    パラメータ

    • val: number

    戻り値 void

静的 i18n

  • get i18n(): i18n
  • ビューワの翻訳を追加するに使用できるi18nextインスタンスを取得します。i18nextフレームワークの詳細については、https://www.i18next.comを参照してください。

    サンプル
    function loadPdfViewer(selector) { 
      // 翻訳を任意のソースからロードできます(例えば、en-pdf-viewer.jsonを参照します)。 
      var myTranslations = { 
            "toolbar": { 
                "open-document": "Open MY document", 
                "pan": "My Pan tool", 
            } 
       }; 
       // 翻訳を初期化します。 
       GcPdfViewer.i18n.init({ 
         resources: { myLang: { viewer: myTranslations } }, 
         defaultNS: 'viewer' 
       }).then(function(t) { 
         // 新しい翻訳が初期化されます。 
         // PDFビューワを作成します。 
         var viewer = new GcPdfViewer(selector, { language: 'myLang' }); 
         viewer.addDefaultPanels(); 
         //viewer.open("sample.pdf"); 
       }); 
    } 
    loadPdfViewer('#root');

    戻り値 i18n

メソッド

addAnnotation

  • addAnnotation(pageIndex: number, annotation: AnnotationBase, args?: undefined | { skipPageRefresh?: undefined | false | true }): Promise<{ annotation: AnnotationBase; pageIndex: number }>
  • 注釈をドキュメントに追加します。SupportApiが必要です。

    サンプル
    // ドキュメントを開いたときに、最初のページに四角形注釈を追加します。 
    viewer.onAfterOpen.register(function() { 
       viewer.addAnnotation(0, { 
           annotationType: 5, // AnnotationTypeCode.SQUARE 
           subtype: "Square", 
           borderStyle: { width: 5, style: 1 }, 
           color: [0, 0, 0], 
           interiorColor: [255, 0, 0], 
           rect: [0, 0, 200, 200] 
        }); 
    });
    サンプル
    // 次の例では、「field1」という名前のフィールドをコピーして、プログラムで2ページ目に配置する方法を示します。 
    // field1という名前のフィールドウィジェットを検索します。 
    var resultData = await viewer.findAnnotation("field1", {findField: 'fieldName'}); 
    // フィールドを複製します。 
    var clonedField = viewer.cloneAnnotation(resultData[0].annotation); 
    // フィールド名プロパティを変更します。 
    clonedField.fieldName = "field1Copy"; 
    // 複製されたフィールドを2ページ目に追加します。 
    viewer.addAnnotation(1, clonedField);
    サンプル
    // ドキュメントを開くときに、最初のページに FileAttachment 注釈を追加します。 viewer.onAfterOpen.register(function() { viewer.addAnnotation(0, { annotationType: 17, // AnnotationTypeCode.FILEATTACHMENT subtype: "FileAttachment", file: { filename: 'attachment.png', content: new Uint8Array([137,80,78,71,13,10,26,10,0,0,0,13,73,72,68,82,0,0,0,45,0,0,0,32,8,6,0,0,0,134,132,241,68,0,0,0,4,103,65,77,65,0,0,177,143,11,252,97,5,0,0,7,56,73,68,65,84,88,9,205,88,11,112,92,85,25,254,255,115,179,129,148,36,155,190,147,187,91,228,49,64,25,99,181,105,169,117,176,149,34,99,113,80,65,165,162,118,168,15,44,3,42,99,55,125,8,29,59,221,90,29,132,38,187,43,56,162,22,5,161,206,240,24,64,40,130,15,156,138,226,3,147,14,118,74,219,41,157,102,138,238,166,155,180,105,246,238,210,144,108,238,158,223,239,44,189,233,110,186,217,172,54,64,239,204,206,61,143,255,241,157,255,156,255,251,207,93,166,183,243,185,185,211,55,125,246,69,239,177,136,166,176,150,92,86,185,201,190,244,238,30,10,47,113,79,199,45,159,142,114,41,221,192,93,125,65,62,203,183,92,136,174,99,226,185,144,57,171,80,14,227,57,22,249,155,102,218,46,110,238,177,195,107,38,191,94,56,95,73,123,194,64,207,220,146,156,81,229,171,217,196,164,110,130,99,31,145,116,144,208,14,210,178,155,20,245,137,102,75,20,53,50,211,249,36,124,53,49,205,133,115,87,72,111,29,146,236,247,142,134,166,31,174,4,176,145,153,16,208,118,52,213,194,108,61,13,144,141,48,248,184,43,58,150,108,245,255,179,28,8,187,189,111,150,178,170,215,65,231,102,44]) }, rect: [0, 0, 20, 20] }); });

    パラメータ

    • pageIndex: number
    • annotation: AnnotationBase
    • オプションの args: undefined | { skipPageRefresh?: undefined | false | true }

    戻り値 Promise<{ annotation: AnnotationBase; pageIndex: number }>

addAnnotationEditorPanel

  • addAnnotationEditorPanel(): PanelHandle
  • 注釈エディタのパネルを追加します。SupportApiが必要です。

    サンプル
    viewer.addAnnotationEditorPanel();

    戻り値 PanelHandle

addArticlesPanel

  • addArticlesPanel(): PanelHandle
  • アーティクルパネルを追加します。

    サンプル
    viewer.addArticlesPanel();

    戻り値 PanelHandle

addAttachmentsPanel

  • addAttachmentsPanel(): PanelHandle
  • 添付ファイルパネルを追加します。

    サンプル
    viewer.addAttachmentsPanel();

    戻り値 PanelHandle

addDefaultPanels

  • addDefaultPanels(): PanelHandle[]
  • デフォルトの順序でサイドバーパネルのデフォルトセットを追加します。デフォルトセットは、「サムネイル」、「検索」、「アウトライン」、「添付ファイル」および「アーティクル」です。

    サンプル
    viewer.addDefaultPanels();

    戻り値 PanelHandle[]

addDocumentListPanel

  • addDocumentListPanel(documentListUrl?: undefined | string): PanelHandle
  • アプリケーションのルートディレクトリにあるdocumentslist.jsonファイル(documentListUrlオプションで指定されたURL)で指定された使用可能なドキュメント配列を使用して、ドキュメントリストパネルをビューワに追加します。documentListUrlオプションのエンドポイントでサービスを指定できます。サービスは、利用可能なドキュメント配列を含むJSON文字列を返す必要があります(例:["pdf1.pdf"、 "pdf2.pdf"])。

    サンプル

    documentslist.jsonファイルのコンテンツの例。

    ["file1.pdf", "file2.pdf"].
    サンプル
    var viewer = new GcPdfViewer("#root", { documentListUrl: "/documentslist.json" }); 
    viewer.addDocumentListPanel();
    サンプル
    var viewer = new GcPdfViewer("#root"); 
    // ドキュメントリストパネルを追加し、documentListUrlオプションを指定します。 
    viewer.addDocumentListPanel('/documentslist.json');
    サンプル
    var viewer = new GcPdfViewer("#root"); 
    // ドキュメントリストパネルを追加し、DATA URIを使用してdocumentListUrlオプションを指定します。 
    viewer.addDocumentListPanel('data:,[{"path": "doc1.pdf"}, {"path": "doc2.pdf", "name": "Hello doc 2", "title": "title 2"}]');

    パラメータ

    • オプション documentListUrl: undefined | string

      オプション。ドキュメントリストサービスURL。

    戻り値 PanelHandle

addFormEditorPanel

  • addFormEditorPanel(): PanelHandle
  • フォームエディタのパネルを追加します。SupportApiが必要です。

    サンプル
    var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' } ); 
    viewer.addDefaultPanels(); 
    viewer.addFormEditorPanel();

    戻り値 PanelHandle

addLayersPanel

  • addLayersPanel(): PanelHandle
  • オプションのコンテンツレイヤーパネルを追加します。

    サンプル
    viewer.addLayersPanel();

    戻り値 PanelHandle

addOutlinePanel

  • addOutlinePanel(): PanelHandle
  • アウトラインパネルを追加します。

    サンプル
    viewer.addOutlinePanel();

    戻り値 PanelHandle

addReplyTool

  • テキスト注釈返信ツールを有効にします。メモ:既存の返信を編集/削除または追加する機能を有効にするには、SupportApiを構成する必要があります。それ以外の場合は、返信ツールが読み取り専用モードになります。

    サンプル
    viewer.addReplyTool('expanded');

    パラメータ

    • 既定値 sidebarState: GcRightSidebarState = "collapsed"

      返信ツールを最初に展開する場合は、「expanded」値を渡します。デフォルト値は「collapsed」です。

    戻り値 void

addSearchPanel

  • addSearchPanel(): PanelHandle
  • 検索パネルを追加します。

    サンプル
    viewer.addSearchPanel();

    戻り値 PanelHandle

addSharedDocumentsPanel

  • addSharedDocumentsPanel(): PanelHandle
  • 共有ドキュメントのリストを含むパネルを追加します。

    サンプル
    var viewer = new GcPdfViewer("#root"); 
    viewer.addSharedDocumentsPanel();

    戻り値 PanelHandle

addStickyNote

  • 付箋をドキュメントに追加します。SupportApiが必要です。

    サンプル

    viewer.addStickyNote(viewer.toViewPortPoint({x: 50, y: 50, pageIndex: 0}));

    パラメータ

    • position: GcSelectionPoint

      ページ相対ポイント。 原点は左上です。 pageIndexを指定する必要があることに注意してください。

    戻り値 void

addThumbnailsPanel

  • addThumbnailsPanel(): PanelHandle
  • サムネイルパネルを追加します。

    サンプル
    viewer.addThumbnailsPanel();

    戻り値 PanelHandle

addViewAreaStyle

  • addViewAreaStyle(cssText: string): string
  • ビュー領域に css スタイルを追加します。

    サンプル
    // 右から左へのテキスト方向機能を有効にします。 viewer.addViewAreaStyle(".gc-text-content, p, h1 { direction: rtl !important }");

    パラメータ

    • cssText: string

    戻り値 string

    スタイル要素識別子。

applyOptions

  • applyOptions(): void
  • 変更されたオプションを適用するには、このメソッドを呼び出します。

    サンプル
    viewer.options.zoomByMouseWheel = { always: false, ctrlKey: true, metaKey: true }; 
    viewer.applyOptions();

    戻り値 void

applyToolbarLayout

  • applyToolbarLayout(): void
  • @see:toolbarLayoutに変更を適用するには、このメソッドを呼び出します。

    サンプル
    viewer.toolbarLayout.viewer.default = ["open", "save", "share"]; 
    viewer.applyToolbarLayout();
    サンプル
    var viewer = new GcPdfViewer(document.querySelector("#viewer")); 
    viewer.addDefaultPanels(); 
    var toolbar = viewer.toolbar; 
    var toolbarLayout = viewer.toolbarLayout; 
    toolbar.addItem({ 
        key: 'custom-add-stamp', 
        icon: { type: "svg", content: '<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path style="fill: #205F78;" d="M20.25 12l-2.25 2.25 2.25 2.25-3.75 3.75-2.25-2.25-2.25 2.25-2.25-2.25-2.25 2.25-3.75-3.75 2.25-2.25-2.25-2.25 2.25-2.25-2.25-2.25 3.75-3.75 2.25 2.25 2.25-2.25 2.25 2.25 2.25-2.25 3.75 3.75-2.25 2.25 2.25 2.25z"></path></svg>' }, 
        title: 'ドキュメントを開いてスタンプを追加します。', 
        checked: false, enabled: false, 
        action: function () { 
          alert("ここでアクションを実装します。"); 
        }, 
        onUpdate: function (args) { 
            var hasDoc = viewer.hasDocument && args.state.session.pageCount >0; 
            return { 
                enabled: hasDoc, 
                checked: false, 
                title: hasDoc ? 'スタンプの追加' : 'ドキュメントを開いてスタンプを追加します。' 
            } 
        } 
    }); 
    toolbarLayout.viewer.default.splice(0, 0, "custom-add-stamp"); 
    viewer.applyToolbarLayout();

    戻り値 void

beginUpdate

  • beginUpdate(): void
  • @see:endUpdateへの次の呼び出しまで通知を中断します。

    サンプル

    viewer.beginUpdate();

    非推奨

    戻り値 void

changeBoundsOrigin

  • changeBoundsOrigin(pageIndex: number, bounds: number[], srcOrigin: "TopLeft" | "BottomLeft", destOrigin: "TopLeft" | "BottomLeft"): number[]
  • このメソッドは、パラメータ境界で指定された長方形の座標系の原点を変更し、変換された長方形の値を返します。

    サンプル
    var pageIndex = 0; 
    var topLeftBounds = [0, 0, 200, 40]; 
    // topLeftBoundsをTopLeft原点からBottomLeft原点に変換します 
    // 最初のページのビューポートを考慮して、結果を 
    // bottomLeftBounds変数に格納します。 
    var bottomLeftBounds = viewer.changeBoundsOrigin(pageIndex, topLeftBounds, 'TopLeft', 'BottomLeft');
    サンプル
    // ビューポートを基準にした注釈の境界を取得します。 
    const pageIndex = 0; 
    const viewPort = viewer.getViewPort(pageIndex); 
    const annotationRect = (await viewer.findAnnotation('10R'))[0].annotation.rect; 
    const invertedRect = viewer.changeBoundsOrigin(pageIndex, annotationRect, 'BottomLeft', 'TopLeft'); 
    const annotationX1 = invertedRect[0] * viewPort.scale; 
    const annotationY1 = invertedRect[1] * viewPort.scale; 
    const annotationX2 = invertedRect[2] * viewPort.scale; 
    const annotationY2 = invertedRect[3] * viewPort.scale;

    パラメータ

    • pageIndex: number

      ページインデックス(0 から始まります)。

    • bounds: number[]

      境界配列: [x1, y1, x2, y2]

    • srcOrigin: "TopLeft" | "BottomLeft"

      ソース座標系の原点。設定できる値は、「TopLeft」または「BottomLeft」です。

    • destOrigin: "TopLeft" | "BottomLeft"

      宛先座標系の原点。設定できる値は、「TopLeft」または「BottomLeft」です。

    戻り値 number[]

changeOrigin

  • changeOrigin(pageIndex: number, y: number, srcOrigin: "TopLeft" | "BottomLeft", destOrigin: "TopLeft" | "BottomLeft"): number
  • このメソッドは、yパラメータで指定された y座標の座標系の原点を変更し、変換された値を返します。

    サンプル
    var pageIndex = 0; 
    var y = 0; 
    // Convert from TopLeft origin to BottomLeft origin 
    // 最初のページからのビューポートを考慮します。 
    var yBottom = viewer.changeOrigin(pageIndex, y, 'TopLeft', 'BottomLeft');

    パラメータ

    • pageIndex: number
    • y: number
    • srcOrigin: "TopLeft" | "BottomLeft"
    • destOrigin: "TopLeft" | "BottomLeft"

    戻り値 number

changeOriginToBottom

  • changeOriginToBottom(pageIndex: any, y: any): number
  • Y座標の原点を下に変換します。

    サンプル
    var pageIndex = 0; 
    var y = 0; 
    // y値をTopLeftからBottomLeft原点に変換します。 
    // 最初のページからのビューポートを考慮します。 
    var yBottom = viewer.changeOriginToBottom(pageIndex, y);

    パラメータ

    • pageIndex: any
    • y: any

    戻り値 number

changeOriginToTop

  • changeOriginToTop(pageIndex: any, y: any): number
  • Y座標の原点を上に変換します。

    サンプル
    var pageIndex = 0; 
    var y = 0; 
    // y値をBottomLeftからTopLeft原点に変換します。 
    // 最初のページからのビューポートを考慮します。 
    var yTop = viewer.changeOriginToTop(pageIndex, y);

    パラメータ

    • pageIndex: any
    • y: any

    戻り値 number

cloneAnnotation

  • パラメータ注釈によって指定された注釈またはフィールドを複製します。SupportApiが必要です。

    サンプル
    // 次の例では、「field1」という名前のフィールドをコピーして、プログラムで2ページ目に配置する方法を示します。 
    // field1という名前のフィールドウィジェットを検索します。 
    var resultData = await viewer.findAnnotation("field1", {findField: 'fieldName'}); 
    // フィールドを複製します。 
    var clonedField = viewer.cloneAnnotation(resultData[0].annotation); 
    // フィールド名プロパティを変更します。 
    clonedField.fieldName = "field1Copy"; 
    // 複製されたフィールドを2ページ目に追加します。 
    viewer.addAnnotation(1, clonedField);

    パラメータ

    戻り値 AnnotationBase

close

  • close(): Promise<void>
  • 開いているドキュメントを閉じます。

    サンプル
    await viewer.close();

    戻り値 Promise<void>

closePanel

  • closePanel(panelHandleOrId?: PanelHandle | string): void
  • サイドバーパネルを閉じます。

    サンプル
    viewer.closePanel();

    パラメータ

    • オプション panelHandleOrId: PanelHandle | string

      オプション。閉じるパネルハンドルまたはパネルID。

    戻り値 void

deletePage

  • deletePage(pageIndex?: undefined | number): Promise<void>
  • ページを削除します。SupportApiが必要です。

    サンプル
    // インデックス3のページを削除します。 
    viewer.deletePage(3);

    パラメータ

    • オプション pageIndex: undefined | number

      削除するページインデックス。

    戻り値 Promise<void>

dispose

  • dispose(): void
  • このメソッドを使用して、PDFビューワによって使用されているリソースを閉じて解放します。

    戻り値 void

download

  • download(fileName?: undefined | string): void
  • ビューワにロードされたPDFドキュメントをローカルディスクにダウンロードします。

    サンプル
    viewer.download();

    パラメータ

    • オプション fileName: undefined | string

      宛先ファイル名。

    戻り値 void

endUpdate

  • endUpdate(): void
  • @see:beginUpdateへの呼び出しによって中断された通知を再開します。

    サンプル

    viewer.endUpdate();

    非推奨

    戻り値 void

execCopyAction

  • execCopyAction(buffer?: CopyBufferData): Promise<boolean>
  • コピーを実行します(Ctrl + C)。SupportApiが必要です。

    サンプル
    viewer.execCopyAction();

    パラメータ

    • オプション buffer: CopyBufferData

      コピーするデータ。

    戻り値 Promise<boolean>

execCutAction

  • execCutAction(buffer?: CopyBufferData): Promise<boolean>
  • 切り取りを実行します(Ctrl + X)。SupportApiが必要です。

    サンプル
    viewer.execCutAction();

    パラメータ

    • オプション buffer: CopyBufferData

      切り出すデータ。

    戻り値 Promise<boolean>

execDeleteAction

  • execDeleteAction(buffer?: CopyBufferData): Promise<boolean>
  • 削除を実行します(Delキー)。SupportApiが必要です。

    サンプル
    viewer.execDeleteAction();

    パラメータ

    • オプション buffer: CopyBufferData

      削除するデータ。

    戻り値 Promise<boolean>

execPasteAction

  • 貼り付けを実行します(Ctrl + V)。SupportApiが必要です。

    サンプル
    if(viewer.hasCopyData) { 
      viewer.execPasteAction({x: 10, y: 10, pageIndex: 0}); 
    }

    パラメータ

    戻り値 Promise<boolean>

findAnnotation

  • findAnnotation(findString: string | number, findParams?: undefined | { findAll?: undefined | false | true; findField?: "id" | "title" | "contents" | "fieldName" | string; pageNumberConstraint?: undefined | number }): Promise<{ annotation: AnnotationBase; pageNumber: number }[]>
  • 開いたドキュメント内に注釈を検索します。検索結果で解決されるpromiseを返します。

    非推奨

    バージョン2.3.1以降で非推奨になりました。

    サンプル
    // 「2R」IDの注釈を検索します。 
    viewer.findAnnotation("2R").then(function(dataArray) { 
      if(dataArray[0]) 
        alert(`Annotation ${dataArray[0].annotation.id} found on page with index ${dataArray[0].pageNumber - 1}.`); 
      else 
        alert('Annotation not found.'); 
    });
    サンプル
    // field1という名前のすべてのフィールドを検索します。 
    viewer.findAnnotation("field1", {findField: 'fieldName', findAll: 
    true}).then(function(dataArray) { 
    
    });
    サンプル
    // 最初のページですべてのテキスト注釈を検索します。 
    const resultArr = await viewer.findAnnotation(1, // 1 - AnnotationTypeCode.TEXT 
                          { findField: 'annotationType', 
                              pageNumberConstraint: 1, findAll: true });

    パラメータ

    • findString: string | number

      クエリを検索します。

    • オプション findParams: undefined | { findAll?: undefined | false | true; findField?: "id" | "title" | "contents" | "fieldName" | string; pageNumberConstraint?: undefined | number }

      パラメータを見つけます。デフォルトでは、注釈はページの制約なしにIDで検索されます。

    戻り値 Promise<{ annotation: AnnotationBase; pageNumber: number }[]>

findAnnotations

  • findAnnotation(findString: string | number, findParams?: undefined | { findAll?: undefined | false | true; findField?: "id" | "title" | "contents" | "fieldName" | string; pageNumberConstraint?: undefined | number }): Promise<{ annotation: AnnotationBase; pageNumber: number }[]>
  • 開いたドキュメント内に注釈を検索します。検索結果で解決されるpromiseを返します。

    サンプル
    // 「2R」IDの注釈を検索します。 
    viewer.findAnnotations("2R").then(function(dataArray) { 
      if(dataArray[0]) 
        alert(`Annotation ${dataArray[0].annotation.id} found on page with index ${dataArray[0].pageIndex}.`); 
      else
         alert('Annotation not found.'); 
    });
    サンプル
    // field1という名前のすべてのフィールドを検索します。 
    viewer.findAnnotations("field1", {findField: 'fieldName', findAll: 
    true}).then(function(dataArray) { 
    
    });

    パラメータ

    • findString: string | number

      クエリを検索します。

    • オプション findParams: undefined | { findAll?: undefined | false | true; findField?: "id" | "title" | "contents" | "fieldName" | string; pageIndexConstraint?: undefined | number }

      パラメータを見つけます。デフォルトでは、注釈はページの制約なしにIDで検索されます。

    戻り値 Promise<{ annotation: AnnotationBase; pageIndex: number }[]>

getDocumentInformation

  • 現在のドキュメントのメタデータ情報を取得します。

    サンプル
    const docMetaInfo = await viewer.getDocumentInformation();

    戻り値 Promise<DocumentInformation>

getDocumentSecurity

  • getDocumentSecurity(): Promise<DocumentSecuritySummary>
  • 現在のドキュメントのセキュリティ情報を取得します。

    サンプル
    const docSecurityInfo = await viewer.getDocumentSecurity();

    戻り値 Promise<DocumentSecuritySummary>

getEvent

  • getEvent(eventName: EventName): EventFan<any>
  • イベントオブジェクトを取得します。

    サンプル
    viewer.getEvent("BeforeAddAnnotation").register(function(args) { 
      console.log(args); 
    });
    viewer.getEvent("AfterAddAnnotation").register(function(args) { 
        console.log(args); 
    });

    パラメータ

    戻り値 EventFan<any>

getPageLocation

  • getPageLocation(pageIndex: number): { x: number; y: number }
  • ブラウザ ウィンドウを基準としたページ ビューの位置を返します。

    サンプル
    var pageLocation = viewer.getPageLocation(0); console.log(‘最初のページの場所' + location.x + ', ' + location.y);
    サンプル
    // ID「10R」の注釈の上に赤い長方形を描画します。 (async function(viewer, annotationId) { const pageLocation = viewer.getPageLocation(0), viewPort = viewer.getViewPort(0), scale = viewPort.scale, viewBox = viewPort.viewBox; const rect = (await viewer.findAnnotation(annotationId))[0].annotation.rect; const x1 = rect[0] * scale + pageLocation.x, x2 = rect[2] * scale + pageLocation.x, y1 = (viewBox[3] - rect[3]) * scale + pageLocation.y, y2 = (viewBox[3] - rect[1]) * scale + pageLocation.y; const div = document.createElement('div'); div.style.position = 'absolute'; div.style.left = `${x1}px`; div.style.top = `${y1}px`; div.style.width = `${x2 - x1}px`; div.style.height = `${y2 - y1}px`; div.style.border = '1px solid red'; document.body.appendChild(div); })(viewer, "10R");
    サンプル
    // マウス クリックでテキスト注釈を追加します。 document.addEventListener("click", (e) => { const target = (e["path"] || (e["composedPath"] && e["composedPath"]()) || [])[0] || e.target, page = target.closest(".page"); if(target.closest(".gc-annotation")) return; if(page) { const pageIndex = page.getAttribute("data-index") * 1, pageLoc = viewer.getPageLocation(pageIndex), scale = viewer.getViewPort(pageIndex).scale; const x = (e.clientX - pageLoc.x) / scale, y = (e.clientY - pageLoc.y) / scale; const rect = viewer.changeBoundsOrigin(pageIndex, [x, y, x + 20, y + 20], "TopLeft", "BottomLeft"); viewer.addAnnotation(pageIndex, { annotationType: 1 , contents: "テキスト注釈の内容", rect }); } });

    パラメータ

    • pageIndex: number

    戻り値 { x: number; y: number }

    • x: number
    • y: number

getPageRotation

  • getPageRotation(pageIndex: number, includeViewRotation?: boolean): number
  • ページの回転値を取得します。

    サンプル
    // 最初のページの回転値を取得します。 
    var rotation = viewer.getPageRotation(0);

    パラメータ

    • pageIndex: number
    • 既定値 includeViewRotation: boolean = true

      ビューを回転します。デフォルトは true です。

    戻り値 number

getPageSize

  • getPageSize(pageIndex: number, includeScale?: undefined | false | true): { height: number; width: number }
  • ページサイズを返します。デフォルトでは、スケールなしでサイズを返します。スケールされた値を取得する場合、includeScale引数にtrueを渡します。

    サンプル
    // 最初のページサイズを取得します。 
    var pageSize = viewer.getPageSize(0);

    パラメータ

    • pageIndex: number

      ページインデックス(0 から始まります)。

    • オプション includeScale: undefined | false | true

      オプション。 trueの場合、メソッドはスケーリングされた値を返します。

    戻り値 { height: number; width: number }

    • height: number
    • width: number

getPageTabs

  • getPageTabs(pageIndex: number): "S" | "R" | "C" | "A" | "W" | undefined
  • ページ上の注釈のタブの順序を取得します。ページ上の注釈に使用されるタブの順序を指定する名前。可能な値は次のとおりです。R-行の順序。 C-列の順序。S-構造の順序(PDFビューワではサポートされていません)。A-注釈の順序。この順序は、注釈コレクション内の注釈の順序を指します。W-ウィジェットの順序。この順序は「注釈」の順序と同じですが、2つのパスが作成されます。最初のパスはウィジェットの注釈のみを選択し、2番目のパスは他のすべての注釈を選択します。

    パラメータ

    • pageIndex: number

    戻り値 "S" | "R" | "C" | "A" | "W" | undefined

getSelectedText

  • getSelectedText(): string
  • テキスト選択の内容を返します。

    サンプル
    alert("ユーザーが選択したテキスト: " + viewer.getSelectedText());

    戻り値 string

getViewPort

  • getViewPort(pageIndex: number): { height: number; rotation: number; scale: number; viewBox: number[]; width: number }
  • PDFページのビューポートの情報を返します。

    サンプル
    // 最初のページのビューポートオブジェクトを取得します。 
    var viewPort = viewer.getViewPort(0);

    パラメータ

    • pageIndex: number

      ページインデックス(0 から始まります)。

    戻り値 { height: number; rotation: number; scale: number; viewBox: number[]; width: number }

    オブジェクトは次のフィールドを含みます。 { viewBox: // 元のページ境界。 [x1, y1, x2, y2]. // ページの元の幅または高さを確認したい場合は、viewBox値を使用して取得できます。 // var pageWidth = viewBox[2] - viewBox[0]; // var pageHeight = viewBox[3] - viewBox[1]; width: // ユーザースペースにページの現在の幅(スケールと回転の値が適用されます), height: // ユーザースペースにページの現在の高さ(スケールと回転の値が適用されます) scale: // アクティブなスケール値の回転 // アクティブ回転値 }

    • height: number
    • rotation: number
    • scale: number
    • viewBox: number[]
    • width: number

goBack

  • goBack(): void
  • ドキュメントの歴史で前に戻します。

    戻り値 void

goForward

  • goForward(): void
  • ドキュメントの歴史で次に進みます。

    戻り値 void

goToFirstPage

  • goToFirstPage(): void
  • 最初のページに移動します。

    サンプル
    viewer.goToFirstPage();

    戻り値 void

goToLastPage

  • goToLastPage(): void
  • 最後のページに移動します。

    サンプル
    viewer.goToLastPage();

    戻り値 void

goToNextPage

  • goToNextPage(): void
  • 次のページに移動します。

    サンプル
    viewer.goToNextPage();

    戻り値 void

goToPage

  • goToPage(pageIndex: number): void
  • 特定のページ番号を入力してページに移動します。

    バージョン以来

    2.3.1

    サンプル
    // 最初のページに移動します。 
    viewer.goToPage(0);

    パラメータ

    • pageIndex: number

    戻り値 void

goToPageNumber

  • goToPageNumber(pageNumber: number): void
  • 特定のページ番号を入力してページに移動します(1から始まります)。

    非推奨

    goToPageNumberメソッドはバージョン2.3.1以降で非推奨になりました。その代わりに、goToPageメソッドまたはpageIndexプロパティを使用します。

    サンプル
    // 2ページ目に移動します。 
    viewer.goToPageNumber(2);

    パラメータ

    • pageNumber: number

    戻り値 void

goToPrevPage

  • goToPrevPage(): void
  • 前のページに移動します。

    サンプル
    viewer.goToPrevPage();

    戻り値 void

hideSecondToolbar

  • hideSecondToolbar(): void
  • 2番目のツールバーを非表示にします。

    サンプル
    viewer.hideSecondToolbar();

    戻り値 void

invalidate

  • invalidate(): void
  • ビューワのすべての視覚的な子要素がレイアウト用に適切に更新されることを確認します。このメソッドを呼び出して、ビューワのサイズが動的に変更されたときに内部コンテンツのサイズを更新します。

    サンプル
    viewer.eventBus.on("viewersizechanged", function() { 
      // ビューワの高さを内側ページ(余白を含め)のコンテンツの高さと同じにします。 
      document.querySelector("#root").style.height = viewer.pageCount * 50 + viewer.pageCount * viewer.getPageSize(0, true).height + "px"; 
      // レイアウトを無効化します。 
      viewer.invalidate(); 
    });

    戻り値 void

loadAndScrollPageIntoView

  • loadAndScrollPageIntoView(pageIndex: number, destArray?: any[]): Promise<boolean>
  • このメソッドは、pageIndexパラメータによって指定されたインデックスでページをロードし、ページをビューにスクロールします。

    サンプル
    // 最初のページをロードして表示します。 
    viewer.loadAndScrollPageIntoView(0);

    パラメータ

    • pageIndex: number

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

    • オプション destArray: any[]

      宛先情報を含む配列 : destArray[0] // nullにすることができます。PDFページ参照(内部使用のみ)。. destArray[1] // 宛先ビュータイプ名が含まれます: { name: 'XYZ' } - 左上隅のポイントおよび拡大縮小率として指定された宛先(ページの左下隅は座標系(0、0)の原点です)。 { name: 'Fit' } - ページをウィンドウに合わせます { name: 'FitH' } - ページの幅をウィンドウに合わせます { name: 'FitV' } - ページの高さをウィンドウに合わせます { name: 'FitR' } - 左上隅と右下隅のポイントで指定された長方形をウィンドウに合わせます { name: 'FitB' } - ページに表示されるすべての要素を含む長方形をウィンドウに合わせます { name: 'FitBH' } - 境界ボックスの幅をウィンドウに合わせます { name: 'FitBV' } - 境界ボックスの高さをウィンドウに合わせます destArray[2] // x位置オフセット destArray[3] // y位置オフセット (メモ:ページの左下隅は座標系(0、0)の原点です) destArray[4] // nullにすることができ、FitRの場合は境界ボックスの幅を含み、XYZの場合はスケールを含みます、 destArray[5] // nullにすることができ、FitRの場合は境界ボックスの高さを含みます。

    戻り値 Promise<boolean>

    ページが完全にロードされ(テキストと注釈レイヤを含む)、スクロールされたときに解決されるpromiseのブール値のを返します。ページが存在しない場合、またはエラーが発生した場合、promiseはfalse値で解決されます。それ以外の場合、promiseはtrue値で解決されます。

loadDocumentList

  • loadDocumentList(documentListUrl?: undefined | string): void
  • 更新されたドキュメントリストをドキュメントリストパネルにロードします。

    サンプル
    viewer.loadDocumentList();
    サンプル
    // DATA URIを使用してドキュメントリストをロードします。 
    viewer.loadDocumentList('data:,[{"path": "doc1.pdf"}, {"path": "doc2.pdf", "name": "Hello doc 2", "title": "title 2"}]');

    パラメータ

    • オプション documentListUrl: undefined | string

      オプション。ドキュメントリストサービスURL。

    戻り値 void

loadSharedDocuments

  • loadSharedDocuments(): void
  • 更新された共有ドキュメントのリストを共有ドキュメントパネルにロードします。

    サンプル
    viewer.loadSharedDocuments();

    戻り値 void

lockAnnotation

  • 編集しないように注釈をロックします。

    パラメータ

    戻り値 Promise<AnnotationBase | null>

newDocument

  • newDocument(params?: { confirm?: undefined | false | true; fileName?: undefined | string } | string): Promise<LoadResult | null>
  • 新しい空白のドキュメントを作成して開きます。SupportApiが必要です。

    サンプル
    // 「test.pdf」という名前の新しい空白のドキュメントを作成し、 
    // アクティブなドキュメントが変更されている場合は確認ダイアログを表示します。 
    viewer.newDocument({ fileName: "test.pdf", confirm: true});

    パラメータ

    • オプション params: { confirm?: undefined | false | true; fileName?: undefined | string } | string

      パラメータオブジェクト:fileName-新しいドキュメントのファイル名、confirm-ドキュメントに変更があるときに確認ダイアログを表示します。

    戻り値 Promise<LoadResult | null>

newPage

  • newPage(params?: undefined | { height?: undefined | number; pageIndex?: undefined | number; width?: undefined | number }): Promise<void>
  • ドキュメントに空白のページを追加します。SupportApiが必要です。

    サンプル
    // 新しい空白のページを作成し、2番目の位置に挿入します。 
    viewer.newPage({pageIndex: 1});

    パラメータ

    • オプション params: undefined | { height?: undefined | number; pageIndex?: undefined | number; width?: undefined | number }

      パラメータオブジェクト:width-ページ幅(ポイント単位)、height-ページの高さ(ポイント単位)、pageIndex-ターゲットページインデックス。

    戻り値 Promise<void>

open

  • open(file?: any | string | URL | Uint8Array | Array<number>, openParameters?: OpenParameters): Promise<LoadResult>
  • PDFドキュメントを開きます。

    サンプル
    viewer.open("Documents/HelloWorld.pdf");
    サンプル
    // Basic認証のヘッダーを指定します。 
    viewer.open("http://localhost:5005/api/pdf-viewer/GetPdf?file=HelloWorld.pdf", { 
      headers: { 
         "Authorization": "Basic " + btoa(unescape(encodeURIComponent("USERNAME:PASSWORD"))), 
         "CustomHeader": "Custom header value" 
      } 
    });

    パラメータ

    • オプション file: any | string | URL | Uint8Array | Array<number>

      PDFドキュメント(文字列)またはバイナリデータ(Uint8Array)へのURL。

    • オプション openParameters: OpenParameters

      パラメータオブジェクトをロードしています。

    戻り値 Promise<LoadResult>

openLocalFile

  • openLocalFile(): any
  • ユーザーがPDFファイルを選択できる[ファイルを開く]ダイアログを表示します。

    サンプル
    viewer.openLocalFile();

    戻り値 any

openPanel

  • openPanel(panelHandleOrId: PanelHandle | string): void
  • サイドバーパネルを開きます。

    サンプル
    const layersPanelHandle = viewer.addLayersPanel(); 
    viewer.open("house-plan.pdf").then(()=> { 
      viewer.openPanel(layersPanelHandle); 
    });

    パラメータ

    • panelHandleOrId: PanelHandle | string

      開くパネルハンドルまたはパネルID。

    戻り値 void

openSharedDocument

  • openSharedDocument(sharedDocumentId: string): Promise<OpenDocumentInfo | null>
  • 共有ドキュメントを開きます。

    サンプル
    viewer.openSharedDocument("shared.pdf");

    パラメータ

    • sharedDocumentId: string

    戻り値 Promise<OpenDocumentInfo | null>

print

  • print(): void
  • ブラウザの[ドキュメントを印刷]ダイアログを開きます。

    サンプル
    viewer.print();

    戻り値 void

redoChanges

  • redoChanges(): void
  • ドキュメントの変更をやり直します。SupportApiが必要です。

    サンプル
    if(viewer.hasRedoChanges) { 
       viewer.redoChanges(); 
    }

    戻り値 void

removeAnnotation

  • removeAnnotation(pageIndex: number, annotationId: string, args?: undefined | { skipPageRefresh?: undefined | false | true }): Promise<boolean>
  • 注釈をドキュメントから削除します。SupportApiが必要です。

    サンプル
    // 最初のページにある「2R」IDの注釈を削除します。 
    viewer.removeAnnotation(0, '2R');

    パラメータ

    • pageIndex: number
    • annotationId: string
    • オプションの args: undefined | { skipPageRefresh?: undefined | false | true }

    戻り値 Promise<boolean>

removeViewAreaStyle

  • removeViewAreaStyle(id: string): boolean
  • ID でビュー領域から css スタイルを削除します。

    サンプル
    const id = viewer.addViewAreaStyle(".gc-text-content { font-size: 20px !important; }"); viewer.removeViewAreaStyle(id);

    パラメータ

    • id: string

      スタイル要素識別子。

    戻り値 boolean

repaint

  • repaint(indicesToRepaint?: number[]): void
  • ページを再描画します。 このメソッドは、ページの注釈も再描画します。

    サンプル
    // 表示されているページの内容と注釈を再描画します。 
    viewer.repaint();
    サンプル
    // ページインデックス「0」および「3」の内容と注釈を再描画します。 
    viewer.repaint([0, 3]);

    パラメータ

    • オプション indicesToRepaint: number[]

      このメソッドを指定する場合、ページインデックスが再描画されます。それ以外の場合、表示されているページを再描画されます。

    戻り値 void

save

  • save(fileName?: undefined | string, format?: "PDF" | "PNG"): Promise<boolean>
  • 変更したPDFドキュメントをローカルディスクにダウンロードします。SupportApiが必要です。

    サンプル
    viewer.save('Test.pdf');

    パラメータ

    • オプション fileName: undefined | string

      宛先ファイル名。

    • デフォルト値 format: "PDF" | "PNG" = "PDF"

    戻り値 Promise<boolean>

saveAsImages

  • saveAsImages(fileName?: undefined | string): Promise<boolean>
  • 現在の PDF ドキュメントのページを PNG 画像として保存し、結果の画像を圧縮して、結果の zip形式のアーカイブをダウンロードします。 SupportAPI が必要です。

    サンプル
    // 現在の PDF ドキュメントのページを PNG 画像として保存し、保存先の zip 形式のファイル名を指定します。: viewer.saveAsImages('Test.zip');

    パラメータ

    • オプション fileName: undefined | string

      オプションです。 保存先の zip 形式のアーカイブ ファイル名。

    戻り値 Promise<boolean>

saveChanges

  • saveChanges(): Promise<boolean>
  • ローカルの変更をサーバーにアップロードします。SupportApiが必要です。

    サンプル
    viewer.saveChanges().then(function(result) { 
      if(result) { 
        alert("The document saved on the server."); 
      } else { 
        alert("Cannot save the document on the server."); 
      } 
    });

    戻り値 Promise<boolean>

scrollAnnotationIntoView

  • scrollAnnotationIntoView(pageIndex: number, annotation: AnnotationBase): any
  • 注釈をスクロールして表示します。

    サンプル
    // 2ページ目にある注釈をスクロールして表示します。 
    viewer.scrollAnnotationIntoView(1, annotation);

    パラメータ

    戻り値 any

scrollPageIntoView

  • scrollPageIntoView(params: { allowNegativeOffset?: undefined | false | true; destArray?: any[]; pageNumber: number }): void
  • ページをスクロールして表示します。

    非推奨

    scrollPageIntoView メソッドはバージョン2.3.1以降で非推奨になりました。その代わりに、goToPageメソッドまたはscrollAnnotationIntoViewプロパティを使用します。

    サンプル
    // 10ページまでスクロールします。 
    viewer.scrollPageIntoView( { pageNumber: 10 } )
    サンプル
    // 注釈境界の長方形をスクロールして表示します。 
    var rectangle = annotation.rect; 
    var pagePosX = rectangle[0]; 
    var pagePosY = rectangle[1] + Math.abs(rectangle[3] - rectangle[1]); 
    viewer.scrollPageIntoView({ pageNumber: pageIndex + 1, destArray: [null, { name: "XYZ" }, 
    pagePosX, pagePosY, viewer.zoomValue / 100.0] });

    パラメータ

    • params: { allowNegativeOffset?: undefined | false | true; destArray?: any[]; pageNumber: number }

      オブジェクト。 スクロールパラメータ: pageNumber - 番号 . ページ番号 . destArray - 宛先情報を含む配列 : destArray[0] // nullにすることができます。PDFページ参照(内部使用のみ)。. destArray[1] // 宛先ビュータイプ名が含まれます: { name: 'XYZ' } - 左上隅のポイントおよび拡大縮小率として指定された宛先(ページの左下隅は座標系(0、0)の原点です)。 { name: 'Fit' } - ページをウィンドウに合わせます { name: 'FitH' } - ページの幅をウィンドウに合わせます { name: 'FitV' } - ページの高さをウィンドウに合わせます { name: 'FitR' } - 左上隅と右下隅のポイントで指定された長方形をウィンドウに合わせます { name: 'FitB' } - ページに表示されるすべての要素を含む長方形をウィンドウに合わせます { name: 'FitBH' } - 境界ボックスの幅をウィンドウに合わせます { name: 'FitBV' } - 境界ボックスの高さをウィンドウに合わせます destArray[2] // x位置オフセット destArray[3] // y位置オフセット (メモ:ページの左下隅は座標系(0、0)の原点です) destArray[4] // nullにすることができ、FitRの場合は境界ボックスの幅を含み、XYZの場合はスケールを含みます、 destArray[5] // nullにすることができ、FitRの場合は境界ボックスの高さを含みます。

      • オプション allowNegativeOffset?: undefined | false | true
      • オプション destArray?: any[]
      • pageNumber: number

    戻り値 void

selectAnnotation

  • selectAnnotation(pageIndex: number | string, annotation?: AnnotationBase | string): Promise<boolean>
  • 編集する注釈を選択します。SupportApiが必要です。

    サンプル
    // 「2R」IDの注釈を選択します。 
    viewer.selectAnnotation("2R");
    サンプル
    // 最後のページにある「9R」IDの注釈を選択します。 
    viewer.selectAnnotation(viewer.pageCount - 1, "9R");

    パラメータ

    • pageIndex: number | string

      ページインデックス(0 から始まります)または注釈ID。

    • オプション annotation: AnnotationBase | string

      注釈IDまたは注釈オブジェクト。

    戻り値 Promise<boolean>

setAnnotationBounds

  • setAnnotationBounds(annotationId: string, bounds: { h: number | undefined; w: number | undefined; x: number | undefined; y: number | undefined }, origin?: "TopLeft" | "BottomLeft", select?: boolean): Promise<void>
  • setAnnotationBoundsメソッドを使用して、注釈の位置やサイズを設定します。

    サンプル
    // 注釈の場所を左上隅に設定します。 
    viewer.setAnnotationBounds('1R', {x: 0, y: 0}); 
    // 注釈の場所を左下隅に設定します。 
    viewer.setAnnotationBounds('1R', {x: 0, y: 0}, 'BottomLeft'); 
    // 注釈サイズを40x40ポイントに設定します。 
    viewer.setAnnotationBounds('1R', {w: 40, h: 40}); 
    // 注釈の位置をx = 50、y = 50(左上)に設定し、サイズを40 x40ポイントに設定します。 
    viewer.setAnnotationBounds('1R', {x: 50, y: 50, w: 40, h: 40});

    パラメータ

    • annotationId: string

      注釈オブジェクトまたは注釈ID。

    • bounds: { h: number | undefined; w: number | undefined; x: number | undefined; y: number | undefined }

      宛先の境界 - x、y、幅、高さはオプションです。

      • h: number | undefined
      • w: number | undefined
      • x: number | undefined
      • y: number | undefined
    • 既定値 origin: "TopLeft" | "BottomLeft" = "TopLeft"

      ソース座標系の原点。デフォルトはTopLeftです。

    • 既定値 select: boolean = false

      編集後に注釈を選択します。デフォルトはfalseです。

    戻り値 Promise<void>

setPageRotation

  • setPageRotation(pageIndex: number, rotation: number, viewRotationIncluded?: boolean): Promise<boolean>
  • ページの絶対回転を度単位で設定します。有効な値は、0、90、180、および270度です。SupportApiが必要です。

    サンプル
    // 最初のページの回転を180度に設定します。 
    await viewer.setPageRotation(0, 180);

    パラメータ

    • pageIndex: number
    • rotation: number
    • 既定値 viewRotationIncluded: boolean = true

    戻り値 Promise<boolean>

setPageSize

  • setPageSize(pageIndex: number, size: { height: number; width: number }): Promise<boolean>
  • ページのサイズを設定します。SupportApiが必要です。

    サンプル
    // 最初のページの新しいページサイズを設定します。 
    viewer.setPageSize(0, { width: 300, height: 500 } );

    パラメータ

    • pageIndex: number
    • size: { height: number; width: number }
      • height: number
      • width: number

    戻り値 Promise<boolean>

setPageTabs

  • setPageTabs(pageIndex: number, tabs: "S" | "R" | "C" | "A" | "W" | undefined): void
  • ページ上の注釈のタブの順序を設定します。ページ上の注釈に使用されるタブの順序を指定する名前。可能な値は次のとおりです。R-行の順序。 C-列の順序。S-構造の順序(PDFビューワではサポートされていません)。A-注釈の順序。この順序は、注釈コレクション内の注釈の順序を指します。W-ウィジェットの順序。この順序は「注釈」の順序と同じですが、2つのパスが作成されます。最初のパスはウィジェットの注釈のみを選択し、2番目のパスは他のすべての注釈を選択します。

    パラメータ

    • pageIndex: number
    • tabs: "S" | "R" | "C" | "A" | "W" | undefined

    戻り値 void

setTheme

  • setTheme(theme?: undefined | string): void
  • アクティブなビューワのテーマを設定します。

    サンプル
    viewer.setTheme("themes/light-blue");

    パラメータ

    • オプション theme: undefined | string

      テーマオプションで指定されたテーマ名。

    戻り値 void

showFormFiller

  • showFormFiller(): void
  • 「フォームフィラー」ダイアログを表示します。

    サンプル
    if(viewer.hasForm) { 
       viewer.showFormFiller(); 
    }

    戻り値 void

showMessage

  • showMessage(message: string, details?: string, severity?: "error" | "warn" | "info" | "debug"): void
  • ユーザーに対してメッセージを表示します。

    パラメータ

    • message: string
    • 既定値 details: string = ""
    • 既定値 severity: "error" | "warn" | "info" | "debug" = "info"

    戻り値 void

showSecondToolbar

  • showSecondToolbar(toolbarKey: SecondToolbarLayoutMode | string): Promise<void>
  • toolbarKey引数で指定されたキーを持つ2番目のツールバーを表示します。

    サンプル
    viewer.showSecondToolbar("draw-tools");

    パラメータ

    • toolbarKey: SecondToolbarLayoutMode | string

    戻り値 Promise<void>

showSignTool

  • [署名の追加]ダイアログを表示します。SupportApiが必要です。

    サンプル
    viewer.showSignTool();

    パラメータ

    • オプション preferredSettings: SignToolSettings

      オプション。これらの設定は、signSettingsオプションよりも優先されます。

    戻り値 void

submitForm

  • submitForm(submitUrl: string): void
  • 「フォームの送信」を実行して、入力されたフォームデータをWebサーバーまたは電子メールに送信します。フォームデータは、HTMLのsubmitメソッドを使用してHTMLフォームとして送信されます。

    サンプル

    絶対URLを使用してフォームをWebサーバーに送信します。

    viewer.submitForm("http://myhost.local/AcceptHtmlForm");
    サンプル

    相対URLを使用してフォームをWebサーバーに送信します。

    viewer.submitForm("/CustomFormHandler");
    サンプル

    フォームを電子メールに送信します。

    viewer.submitForm("mailto:myform@example.com");

    パラメータ

    • submitUrl: string

    戻り値 void

toViewPortPoint

  • ページスケールを考慮して、ポイントをページのビューポートに変換します。

    サンプル

    viewer.addStickyNote(viewer.toViewPortPoint({x: 50, y: 50, pageIndex: 0}));

    パラメータ

    戻り値 GcSelectionPoint

triggerEvent

  • Trigger イベント。

    サンプル
    // CustomEventをリッスンします。 
    viewer.getEvent("CustomEvent").register(function(args) { 
      console.log(args); 
    }); 
    // CustomEventをトリガーします。 
    viewer.triggerEvent("CustomEvent", { arg1: 1, arg2: 2});

    パラメータ

    戻り値 void

undoChanges

  • undoChanges(): void
  • ドキュメントの変更を元に戻します。SupportApiが必要です。

    サンプル
    if(viewer.hasUndoChanges) { 
       viewer.undoChanges(); 
    }

    戻り値 void

unlockAnnotation

  • 編集しないように注釈をロック解除します。

    パラメータ

    戻り値 Promise<AnnotationBase | null>

unselectAnnotation

  • unselectAnnotation(): any
  • 注釈の選択をリセットします。SupportApiが必要です。

    サンプル
    viewer.unselectAnnotation();

    戻り値 any

updateAnnotation

  • updateAnnotation(pageIndex: number, annotation: AnnotationBase, args?: undefined | { skipPageRefresh?: undefined | false | true }): Promise<{ annotation: AnnotationBase; pageIndex: number }>
  • 注釈を更新します。SupportApiが必要です。

    サンプル
    // 最初のページの注釈を更新します(ページインデックスは0です)。 
    viewer.updateAnnotation(0, annotation1);

    パラメータ

    • pageIndex: number
    • annotation: AnnotationBase
    • オプションの args: undefined | { skipPageRefresh?: undefined | false | true }

    戻り値 Promise<{ annotation: AnnotationBase; pageIndex: number }>

    更新された注釈オブジェクトによってpromiseが解決されます。

updateAnnotations

  • updateAnnotations(pageIndex: number, annotations: AnnotationBase | AnnotationBase[], args?: undefined | { skipPageRefresh?: undefined | false | true }): Promise<{ annotations: AnnotationBase[]; pageIndex: number }>
  • 複数の注釈を同時に更新します。SupportApiが必要です。

    サンプル
    // 2ページ目の注釈を更新します(ページインデックスは1です)。 
    var annotationsToUpdate = [annotation1, annotation2]; 
    viewer.updateAnnotations(1, annotationsToUpdate);

    パラメータ

    • pageIndex: number
    • annotations: AnnotationBase | AnnotationBase[]
    • オプションの args: undefined | { skipPageRefresh?: undefined | false | true }

    戻り値 Promise<{ annotations: AnnotationBase[]; pageIndex: number }>

    更新された注釈オブジェクトによってpromiseが解決されます。

updateRadioGroupValue

  • updateRadioGroupValue(fieldName: string, newValue: string, skipPageRefresh?: undefined | false | true): Promise<boolean>
  • fieldNameパラメータで指定されたラジオボタングループを新しいフィールド値で更新します。

    サンプル
    viewer.updateRadioGroupValue("radiogroup1", "3", true);

    パラメータ

    • fieldName: string

      グループ化されたラジオボタンのフィールド名。

    • newValue: string

      新しいfieldValue。

    • オプション skipPageRefresh: undefined | false | true

      ブール値。ページ表示を更新する必要がない場合、trueに設定します。デフォルトはfalseです。

    戻り値 Promise<boolean>

    promiseはブール値で解決されます。trueの場合、-ラジオボタンが更新され、falseの場合、-エラーが発生しました。

validateForm

  • validateForm(validator?: undefined | ((fieldValue: string | string[], field: WidgetAnnotation) =>boolean | string), silent?: undefined | false | true, ignoreValidationAttrs?: undefined | false | true): string | boolean
  • このメソッドを使用して、アクティブなフォームを検証し、検証結果を取得します。

    サンプル
    // すべてのフォームフィールドを検証します。各フィールドの値は「はい」または「いいえ」である必要があります。 
    viewer.validateForm((fieldValue, field) => { return (fieldValue === "はい" || fieldValue === "いいえ") ? true : "可能な値はYESまたはNOです。"; });

    パラメータ

    • オプション validator: undefined | ((fieldValue: string | string[], field: WidgetAnnotation) =>boolean | string)

      オプション。フォームの各フィールドに対して呼び出されるValidator関数。検証エラーに関するメッセージを含む文字列値を返すことができ、このメッセージはUIに表示されます。成功した結果の場合はtrueまたはnullを返します。

    • オプション silent: undefined | false | true

      オプション。ユーザーにメッセージを表示せず、最終的な検証結果を取得する場合、trueを渡します。

    • オプション ignoreValidationAttrs: undefined | false | true

      オプション。required、min、max、minLength、maxLength、email、patternなどのフィールド属性を使用した検証をスキップする場合、trueを渡します。これらの属性は無視されます。

    戻り値 string | boolean

    検証が成功した場合はtrueを返し、検証が失敗した場合はfalseまたは検証エラーメッセージを含む文字列を返します。

静的 findControl

  • findControl(selector: string | HTMLElement): GcPdfViewer | undefined
  • ホスト要素またはホスト要素セレクターを使用してビューワインスタンスを取得します。

    サンプル
    var viewer = GcImageViewer.findControl("#root");

    パラメータ

    • selector: string | HTMLElement

    戻り値 GcPdfViewer | undefined