DsPdfViewer クラス

ビューワの翻訳を追加するに使用できる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 DsPdfViewer(selector, { language: 'myLang' });
 viewer.addDefaultPanels();
 //viewer.open("sample.pdf");
 });
}
loadPdfViewer('#root');

メインウィンドウのホスト要素を取得します。

レポートの表示中にエラーが発生したときに呼び出されるコールバックを取得または設定します。

ドキュメントが変更された（新しいドキュメントが開かれた、ドリルされた、または「親に戻る」が発行されたなど）ことを示すイベント。

ドキュメントのビューが変更された（ 新しいドキュメントが開かれた、更新された、切り替えられたなど）ことを示すイベント。

ドキュメントのロードの進行状況を示すイベント。

ビューワの状態が変更されたことを示します。

パネルの変更時に発生する一時的なエクスポーズイベント。

表示されているドキュメントの状態を取得します。

表示モード (単一ページまたは連続) を取得または設定します。

ズーム変換の対象要素を取得または設定します。 「page」が設定されている場合、各ページは個別に変換されます (デフォルトの動作)。 「viewport」が設定されている場合、ビューポート要素全体が変換されます。

ビューワの背景色を取得または設定します。デフォルト値は「transparent」です。

ページ表示の装飾モードを取得または設定します。

現在のドキュメントを取得します。

ビューワの初期設定を取得します。

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

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

（内部使用のみ）使用可能なイベント名は、outlineloaded、attachmentsloaded、namedaction、pagemode、fileattachmentannotation、pagerendered、pagecancelled、scalechange、pagesinit、pagesloaded、documentchanged、rotationchanging、updateviewarea、undostorechanged、show-custom-layout、hide-custom-layout、annotationeditstarted、unselectannotation、annotation-bounds-change、pagechange、mousemodechange、request-answer、textlayerready、viewersizechanged、articlebeadnavigate、error、open、pagelabels、documentloadです。

サンプル

// 例: 注釈の選択/選択解除イベントをリッスンします。
var viewer = DsPdfViewer.findControl("#root");
viewer.eventBus.on("annotationeditstarted", (args)=> {
 console.log("Annotation selected, annotation id: " + args.annotationId); 
});
viewer.eventBus.on("unselectannotation", (args)=> {
 console.log("Annotation unselected, annotation id: " + args.annotationId); 
});

DsPdfViewerの現在のバージョンと互換性のある必要なSupportApiバージョンを取得します。

SupportApiの接続されたバージョンを取得します。

SupportApiで使用されるGcPDFライブラリのバージョンを取得します。

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

サンプル

if(viewer.canEditDocument) {
 alert("Document editing features enabled.");
} else {
 alert("Document editing features disabled.");
}

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

サンプル

viewer.currentUserName = "John";

サンプル

alert("The current user name is " + viewer.currentUserName);

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

サンプル

viewer.currentUserName = "John";

サンプル

alert("The current user name is " + viewer.currentUserName);

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

サンプル

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

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

サンプル

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

ファイルデータを取得します。 keepFileDataオプションがtrueに設定する場合に使用できます。

サンプル

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

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

• [ファイルを開く]ダイアログを使用してローカルファイルを開いた場合、ローカルファイル名を返します。
• 「newDocument」メソッドを使用して新しいファイルが作成された場合、そのメソッドに渡された引数を返します。
• options.friendlyFileNameが空でない場合、その値を返します。
• 「open」メソッドに渡されたURLから生成された名前を返します。

サンプル

var viewer = new DsPdfViewer('#root');
viewer.onAfterOpen.register(function() {
 alert("The document is opened, the fileName is " + viewer.fileName);
});
viewer.open('MyDocuments/Test.pdf');

PDF ドキュメントのファイル サイズをバイト単位で取得します。

サンプル

const fileSizeBytes = await viewer.fileSize;

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

サンプル

var viewer = new DsPdfViewer('#root');
viewer.onAfterOpen.register(function() {
 alert("The document is opened, the fileUrl is " + viewer.fileUrl);
});
viewer.open('MyDocuments/Test.pdf');

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

サンプル

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.");
 }
});

アクティブ化されたエディタモード名。

左側のサイドバーのAPI。

サンプル

viewer.leftSidebar.hide();

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

サンプル

const fileData = viewer.storage.getItem(annotation.fileId);

サンプル

viewer.storage.setItem(fileId, bytes);

サンプル

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

viewer.newDocument().then(function() {
 var xhr = new XMLHttpRequest();
 xhr.open('GET', 'http://localhost/sample.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(); 
});

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

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

サンプル

if(viewer.hasChanges) {
 alert("The document has been changed.");
}

コピーしたバッファにデータが含まれるかどうかを示します。

サンプル

if(viewer.hasCopyData) {
 viewer.execPasteAction();
}

ドキュメントがビューにロードされるかどうかを示します。

サンプル

if(!viewer.hasDocument) {
 viewer.open("sample.pdf");
}

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

サンプル

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

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

サンプル

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

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

既定値

0

サンプル

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

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

既定値

0

サンプル

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

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

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

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

サンプル

var modificationsState = viewer.modificationsState;
 console.log(modificationsState);

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

サンプル

// optionalContentConfigプロパティを使用して、使用可能なすべてのレイヤーに関する情報を印刷します。
const config = await viewer.optionalContentConfig;
console.table(config.getGroups());

サンプル

const config = await viewer.optionalContentConfig;
// 「13R」IDのオプションのコンテンツグループをオフにします。 
config.setVisibility("13R", false); 
// 表示されているページを再描画します。
viewer.repaint();

構造ツリーのデータ。

サンプル

const viewer = new DsPdfViewer(selector);
await viewer.open("sample.pdf");
const structureTree = await viewer.structureTree;
if(structureTree) {
 console.log(structureTree);
}

戻り値

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

ビューワのオプション。

サンプル

viewer.options.zoomByMouseWheel = { always: true };
viewer.applyOptions();

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

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

サンプル

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

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

サンプル

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

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

 // SearchPanel を開かずにすべての検索結果を強調表示します。
 const searchIterator = viewer.searcher.search({ Text: "test", MatchCase: true, HighlightAll: true });
 searchIterator.next();
 searcher.applyHighlight();

// すべての検索結果を繰り返します。
 const searcher = viewer.searcher;
 var searchResults = [];
 const searchIterator = searcher.search({ Text: textToSearch, MatchCase: true });
 var searchResult = await searchIterator.next();
 if (searchResult.value)
 searcher.highlight(searchResult.value)
 while (searchResult.value && !searchResult.done) {
 const searchResultValue = searchResult.value;
 searchResults.push(`index: ${searchResultValue.ItemIndex}, text: ${searchResultValue.DisplayText}, pageIndex: ${searchResultValue.PageIndex}`);
 searchResult = await searchIterator.next();
 }
 console.log("Search results: " + (searchResults.length ? searchResults.join("; ") : "No search results"));

サンプル

// ドキュメントを開き、「wildlife」というテキストを見つけて、最初の結果を強調表示します。
async function loadPdfViewer(selector) {
 var viewer = new DsPdfViewer(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 DsPdfViewer(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('next search result:');
 console.log(searchResult.value);
 resultsCount++;
 } else {
 const pageCount = _doc.pageCount.totalPageCount || _doc.pageCount.renderedSoFar;
 console.log('search progress, page index is ' + searchResult.value.PageIndex);
 }
 }
 else {
 console.log("Search completed");
 break;
 }
 }
 while(!searchResult.done);
 console.log('Total results count is ' + resultsCount);
 }

SupportApiクライアントを取得します。SupportApiが必要です。

サンプル

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

さまざまなビューワモード（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', 'search', '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', '$split', 'pdf-organizer'

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', '$split', 'pdf-organizer'

サンプル

// ツールバーのレイアウトをカスタマイズします。
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 DsPdfViewer('#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();

さまざまなビューワモード（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', '$split', 'pdf-organizer'

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', '$split', 'pdf-organizer'

サンプル

// ツールバーのレイアウトをカスタマイズします。
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 DsPdfViewer('#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;

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

既定値

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

既定値

PDFビューワの現在のバージョンを返します。

サンプル

alert("The DsPdfViewer version is " + viewer.version);

返信ツールが追加されるかどうかを示します。

サンプル

var viewer = new DsPdfViewer('#root');
if(viewer.hasReplyTool) {
 alert("The Reply Tool has not been added to the viewer.");
} else {
 alert("The Reply Tool has been added to the viewer.");
}
viewer.open('Test.pdf');

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

サンプル

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

一意のドキュメント識別子。

サンプル

var viewer = new DsPdfViewer('#root');
viewer.onAfterOpen.register(function() {
 alert("The document opened, an unique document identifier is "+ viewer.fingerprint);
});
viewer.open('Test.pdf');

ドキュメント内のすべての注釈を取得します。

サンプル

• var viewer = new DsPdfViewer('#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');

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

サンプル

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

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

サンプル

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

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

サンプル

if(viewer.hasForm) {
 viewer.showFormFiller();
}

ビューワがサーバーに永続的な接続があるかどうかを示す値を取得します。

• if(viewer.hasPersistentConnection) {
• viewer.getSharedDocuments().then(function(result) {
• });
• }

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

サンプル

if(viewer.hasUndoChanges) {
 viewer.undoChanges();
}

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

サンプル

if(viewer.hasRedoChanges) {
 viewer.redoChanges();
}

元に戻すストアの現在の状態。 このプロパティは読み取り専用であり、プログラムによってコレクションの要素を変更しないことに注意してください。 Undo API メソッドを使用して、ビューワのエディタの状態を変更します。 Undo API のプロパティは、hasUndoChanges、hasRedoChanges、undoIndex です。 undoCount Undo API メソッドは、undoChanges()、redoChanges() です。

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

サンプル

alert("The current Undo level index is " + viewer.undoIndex);

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

サンプル

alert("Undo levels count is " + viewer.undoCount);

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

サンプル

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

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

サンプル

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

ページ数を取得します。

サンプル

var viewer = new DsPdfViewer('#root');
viewer.onAfterOpen.register(function() {
 alert("The document opened. Total number of pages: " + viewer.pageCount);
});
viewer.open('Test.pdf');

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

サンプル

if(viewer.isDocumentShared) {
 alert("The document is open in shared mode.");
}

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

サンプル

// 拡大値を150％に設定します。
viewer.zoomValue = 150;

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

サンプル

// 拡大値を150％に設定します。
viewer.zoomValue = 150;

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

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

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

サンプル

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

エラーを示すイベント。

サンプル

var viewer = new DsPdfViewer('#root');
viewer.addDefaultPanels();
viewer.onError.register(handleError);
viewer.open('Test.pdf');

function handleError(eventArgs) {
 var message = eventArgs.message;
 if (message.indexOf("Invalid PDF structure") !== -1) {
 alert('Unable to load pdf document, pdf document is broken.');
 } else {
 alert('Unexpected error: ' + message);
 }
}

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

サンプル

var viewer = new DsPdfViewer('#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');

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

サンプル

var viewer = new DsPdfViewer('#root');
viewer.onAfterOpen.register(function() {
 alert("The document opened.");
});
viewer.open('Test.pdf');

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

サンプル

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

onAfterAddAnnotation　イベント。

サンプル

viewer.onAfterAddAnnotation.register(function(args) {
 console.log(args);
});

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

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

onAfterUpdateAnnotation　イベント。

サンプル

viewer.onAfterUpdateAnnotation.register(function(args) {
 console.log(args);
});

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

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

onAfterRemoveAnnotation　イベント。

サンプル

viewer.onAfterRemoveAnnotation.register(function(args) {
 console.log(args);
});

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

サンプル

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

2番目のツールバーのAPI。

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

サンプル

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

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

サンプル

var isUpdatingFlag = viewer.isUpdating;