Viewer クラス

ビューワのコンポーネント。

階層

Viewer

Accessors

コンストラクタ

constructor

メソッド

Accessors

availableExports

get availableExports(): string[]
set availableExports(formatKeys: string[]): any

ビューワにエクスポートプラグインが追加されたときにリストに表示されるエクスポートオプションを設定します。

viewer.availableExports = [''] //読み込んだすべてのエクスポートモジュールを無効にします。
viewer.availableExports = ['pdf'] //PDF以外のエクスポート形式を除外します。
viewer.availableExports = [] //読み込んだすべてのエクスポートモジュールを有効にします。

戻り値 string []

ビューワにエクスポートプラグインが追加されたときにリストに表示されるエクスポートオプションを設定します。

viewer.availableExports = [''] //読み込んだすべてのエクスポートモジュールを無効にします。
viewer.availableExports = ['pdf'] //PDF以外のエクスポート形式を除外します。
viewer.availableExports = [] //読み込んだすべてのエクスポートモジュールを有効にします。

引数

formatKeys: string[]

戻り値 any

currentPage

get currentPage(): number

ビューワに表示される現在のドキュメントのページ数を取得または設定します（1ベースの値）。レポートがロードされていない場合は、0を返します。
```
var pageNumber = viewer.currentPage;
```
戻り値 number

documentLoaded

get documentLoaded(): EventFan<DocumentLoadEventArgs>

ビューワにレポートが完全に描画されたときに発生するdocumentLoadedイベントを設定および登録します。再描画するときも動作します。
```
type DocumentLoadedEventArgs = {
    pageCount: number;
    cancelled?: boolean;
}

viewer.documentLoaded.register(args => console.log('レポートが完全に描画されました。 ', args));
```
戻り値 EventFan < DocumentLoadEventArgs >

errorHandler

get errorHandler(): ErrorHandler
set errorHandler(handler: ErrorHandler): any

ビューワに対してエラーハンドラを取得または設定します。ユーザーがエラーの表示をカスタマイズする場合は、既存のエラーハンドラをオーバーライドし、エラーダイアログを表示しません。

type ErrorMessage = {
    severity: "エラー" | "警告" | "情報" | "デバッグ";
    message: string,
    details: string);

function handler(error: ErrorMessage){
    console.log(error.message);
    return true; // このエラーをビューワのエラーダイアログに表示しない場合は、trueを返します。
}


viewer.errorHandler = handler;

戻り値 ErrorHandler

type ErrorMessage = {
    severity: "エラー" | "警告" | "情報" | "デバッグ";
    message: string,
    details: string);

function handler(error: ErrorMessage){
    console.log(error.message);
    return true; // このエラーをビューワのエラーダイアログに表示しない場合は、trueを返します。
}


viewer.errorHandler = handler;

引数

handler: ErrorHandler

戻り値 any

history

get history(): HistoryApi

ページ表示履歴を表示します。

戻り値 HistoryApi

mouseMode

get mouseMode(): ViewerMouseMode
set mouseMode(value: ViewerMouseMode): any

ビューワのマウスモードを取得または設定します。パンモード（Pan）や選択モード（Selection）から選択できます。
```
viewer.mouseMode = "pan";
```
戻り値 ViewerMouseMode
ビューワのマウスモードを取得または設定します。パンモード（Pan）や選択モード（Selection）から選択できます。
```
viewer.mouseMode = "pan";
```
引数
- value: ViewerMouseMode
戻り値 any

pageCount

get pageCount(): number

レポートにおけるページの合計数を取得します。
```
var totalPages = viewer.pageCount;
```
戻り値 number

renderMode

get renderMode(): ViewerRenderMode
set renderMode(mode: ViewerRenderMode): any

ビューワでページの表示モードを取得また設定します。通常モード（Paginated）、あるいはゲラモード（Galley）の2種類で表示できます。
```
viewer.renderMode = 'Galley';
```
戻り値 ViewerRenderMode
ビューワでページの表示モードを取得また設定します。通常モード（Paginated）、あるいはゲラモード（Galley）の2種類で表示できます。
```
viewer.renderMode = 'Galley';
```
引数
- mode: ViewerRenderMode
戻り値 any

reportLoaded

get reportLoaded(): EventFan<ReportLoadEventArgs>

ビューワにレポートが読み込んだときに発生するreportLoadedイベントを設定および登録します。ドリルスルーのレポートを考慮しません。

 type ReportLoadedEventArgs = {
    reportSource: string | RDLReportDefinition;
    parameters: ParameterDescriptor[];
}


viewer.reportLoaded.register(args => console.log('レポートが読み込まれました。 ', args));

戻り値 EventFan < ReportLoadEventArgs >

stateChanged

get stateChanged(): EventFan<ChangedEventArgs>

ビューワの状態が変わったときに発生します。ビューワの設定と表示されているドキュメントの変更などが含まれています。

戻り値 EventFan < ChangedEventArgs >

toolbar

get toolbar(): Toolbar

ビューワツールバーのコンポーネントを取得します。

戻り値 Toolbar

viewMode

get viewMode(): ViewerViewMode | ViewMode
set viewMode(value: ViewerViewMode | ViewMode): any

ビューモードを取得または設定します。

enum ViewMode {
    SinglePage = 0,
    ContinousPage = 1
}
var viewMode = viewer.viewMode //デフォルトでは「単一ページ」モードです
//「連続ページ」モードに設定します
viewer.viewMode = 'continuous' // または viewer.viewMode = 1;

戻り値 ViewerViewMode | ViewMode

ビューモードを取得または設定します。

enum ViewMode {
    SinglePage = 0,
    ContinousPage = 1
}
var viewMode = viewer.viewMode //デフォルトでは「単一ページ」モードです
//「連続ページ」モードに設定します
viewer.viewMode = 'continuous' // または viewer.viewMode = 1;

引数

value: ViewerViewMode | ViewMode

戻り値 any

zoom

get zoom(): ViewerZoomMode
set zoom(value: ViewerZoomMode): any

現在のズーム倍率を示す値を取得または設定します。設定できる値は以下の通りです。
- 0～3： 0.5は50％、および3は300％の表示倍率を示します。
- 「FitToWidth」や「FitPage」のような定数値（大文字／小文字の区別なし）
```
var currentZoom = viewer.zoom; //デフォルト値は 1（100%）です。
「ページ幅に合わせる」モードに設定します。
viewer.zoom = 'FitToWidth';
//値を検証します
var newValue = viewer.zoom;
//newValueはFitToWidthと等しくなります。
```
戻り値 ViewerZoomMode
現在のズーム倍率を示す値を取得または設定します。設定できる値は以下の通りです。
- 0～3： 0.5は50％、および3は300％の表示倍率を示します。
- 「FitToWidth」や「FitPage」のような定数値（大文字／小文字の区別なし）
```
var currentZoom = viewer.zoom; //デフォルト値は 1（100%）です。
「ページ幅に合わせる」モードに設定します。
viewer.zoom = 'FitToWidth';
//値を検証します
var newValue = viewer.zoom;
//newValueはFitToWidthと等しくなります。
```
引数
- value: ViewerZoomMode
戻り値 any

コンストラクタ

constructor

new Viewer(element: any, options?: ViewerOptions): Viewer

id='viewer'でコンテナのdiv要素にビューワを作成し、言語を設定します。
```
var options = { language: 'ru' };
var viewer = new ActiveReports.Viewer('#viewer', options );
viewer.open('report.json');
```
引数
- element: any
  ビューワコントロールを描画する位置。次の値のいずれかを受け入れます。
  - 文字列: ビューワを描画するDOMセレクターの要素（例：#viewer）。
  - DOM要素（例、 document.getElementById('viewer')）。
  - JQueryオブジェクト（例、$('#viewer')）。
- オプション options: ViewerOptions
  
  コントロールの設定。
戻り値 Viewer

メソッド

backToParent

backToParent(): void

親レポートをビューワに表示します。
```
viewer.backToParent();
```
戻り値 void

canBackToParent

canBackToParent(): boolean

親レポートに戻ることができる場合、trueを返します。

戻り値 boolean

dispose

dispose(): void

DOM要素からコントロールを削除し、リソース（内部的）を解放します。

戻り値 void

export

export(format: string, settings: Record<string, string | boolean | number>, params?: undefined | { cancel?: undefined | ((): boolean ) }): Promise<ExportResult>

レポートを指定したエクスポート形式に表示します。結果を含むオブジェクトをblobオブジェクトまたは文字列として、およびダウンロード機能を返します。このblobオブジェクトを使用するか、ファイルを直接ダウンロードできます。また、PDFエクスポート設定でプレーンテキストを指定することができます。例えば、**{title: 'Title', author: 'Author Name', ownerPassword: '1'}**。
```
var options = {filename:"Invoice List"};
var cancelCallback = function(){
    return false; // エクスポートを続行します。エクスポート処理をキャンセルする場合、trueを返します。
}
viewer.export('pdf', options, {cancel: cancelCallback }).then(result => doSmthWithBlob(result.data));
//または、ファイルをダウンロードできます。
viewer.export('pdf', options, {cancel: cancelCallback }).then(result => result.download('Invoice List'));
```
引数
- format: string
  
  「pdf」、「xlsx」または「html」のいずれかの形式識別子にエクスポートします。
- settings: Record<string, string | boolean | number>
  
  形式に固有のエクスポート設定。
- オプション params: undefined | { cancel?: undefined | ((): boolean ) }
  
  追加のエクスポートのカスタマイズ。
戻り値 Promise < ExportResult >

goToFirstPage

goToFirstPage(): void

ドキュメントの最初のページに移動します。
```
viewer.goToFirstPage();
```
戻り値 void

goToLastPage

goToLastPage(): void

ドキュメントの最後のページに移動します。
```
viewer.goToLastPage();
```
戻り値 void

goToNextPage

goToNextPage(): void

ドキュメントの次のページに移動します。
```
viewer.goToNextPage();
```
戻り値 void

goToPage

goToPage(pageNumber: number): void

指定したページに移動します。（1から始まる番号）
```
viewer.goToPage(3); //3ページ目に移動します。
```
引数
- pageNumber: number
戻り値 void

goToPrevPage

goToPrevPage(): void

前のページに移動します。
```
viewer.goToPrevPage();
```
戻り値 void

highlight

highlight(result: SearchResult | null): Promise<void>

検索結果を強調表示します。

results = [];


function search(text){
    viewer.search({text}, function(result){
        results.push(result)
    }).then(function(status){
        console.log(status)
    })
}


function nextSearchResult(index){
    if(results.length == 0){
        viewer.highlight(null);
        return;
    }
    viewer.hightlight(resutls[index]);
}

引数

result: SearchResult | null

戻り値 Promise < void >

open

open(report: string | Report | PageReport, settings?: Partial<ReportSettings>): Promise<LoadResult>

「ファイル」からレポートを開き、またはjson文字列としてレポートを読み込みます。
```
var viewer = new ActiveReports.Viewer(#viewerPlace);
viewer.open('report.json');
```
引数
- report: string | Report | PageReport
  
  レポートテンプレートは、レポートURI、レポート定義、またはPageReportクラスのインスタンスになります。
- オプション settings: Partial<ReportSettings>
  
  レポートの追加設定（名前、パラメータ）。
戻り値 Promise < LoadResult >

print

print(): void

現在開いているレポートを印刷します。
```
viewer.print();
```
戻り値 void

refresh

refresh(): void

レポートを再描画します。
```
viewer.refresh();
```
戻り値 void

registerFont

registerFont(...fonts: FontDescriptor[]): Promise<void>
registerFont(configUri: string): Promise<void>

非推奨
FontStore.registerFontsを使用します。

指定されたフォントをCSSとPDFのエクスポートに登録します。これにより、フォントが無い環境でもエクスポートしたファイルが正しく表示されます。
```
viewer.registerFont('./fontsConfig.json');
```
引数
- Rest ...fonts: FontDescriptor[]
戻り値 Promise < void >
非推奨
FontStore.registerFontsを使用します。

指定されたフォントをCSSとPDFのエクスポートに登録します。これにより、フォントが無い環境でもエクスポートしたファイルが正しく表示されます。
```
viewer.registerFont('./fontsConfig.json');
```
引数
- configUri: string
戻り値 Promise < void >

resetDocument

resetDocument(): Promise<void>

ビューワに表示されている文書をリセットします。

戻り値 Promise < void >

search

search(options: SearchOptions, resultFn: (result: SearchResult): void, progressFn?: undefined | ((progress: { pageCount: number | null; pageIndex: number }): void ), cancel?: CancellationToken): Promise<SearchStatus>

現在開いているレポートで指定した文字列を検索検索を実行します。また、独自のカスタム検索ペインを作成することができます。
```
viewer.search({
    text: "船",
    matchCase: true
}, function(result){
    console.log(result)
}, function(progress){
    console.log(progress)
})
```
引数
- options: SearchOptions
- resultFn: (result: SearchResult): void
  - - (result: SearchResult): void
    - 引数
      - result: SearchResult
      戻り値 void
- オプション progressFn: undefined | ((progress: { pageCount: number | null; pageIndex: number }): void )
- オプション cancel: CancellationToken
戻り値 Promise < SearchStatus >

toggleFullScreen

toggleFullScreen(enabled?: undefined | false | true): void

ビューワをフルスクリーンモードで起動します。
```
viewer.toggleFullScreen();
```
引数
- オプション enabled: undefined | false | true
戻り値 void

toggleSidebar

toggleSidebar(visible?: undefined | false | true): void

サイドバーの表示を切り替えます（表示または非表示にします）。パラメータが渡されない場合、トグルとして機能します。
```
viewer.toggleSidebar(); //ツールバーを非表示にします。
viewer.toggleSidebar(true);//ツールバーを表示します。
```
引数
- オプション visible: undefined | false | true
  
  新しく表示する時の状態。値は渡されない場合、関数が現在の状態を切り替えます。
戻り値 void

toggleToolbar

toggleToolbar(show?: undefined | false | true): void

ツールバーの表示を切り替えます（表示または非表示にします）。
```
viewer.toggleToolbar(); //ツールバーの表示を切り替えます。
viewer.toggleToolbar(true); //ツールバーを表示します。
```
引数
- オプション show: undefined | false | true
  
  ツールバーをオンにするために** true **を渡します、逆も同様です。表示を切り替えるために値を渡さないでください。
戻り値 void

Viewer クラス

階層

Accessors

コンストラクタ

メソッド

Accessors

availableExports

戻り値 string []

引数

formatKeys: string[]

戻り値 any

currentPage

戻り値 number

documentLoaded

戻り値 EventFan < DocumentLoadEventArgs >

errorHandler

戻り値 ErrorHandler

引数

handler: ErrorHandler

戻り値 any

history

戻り値 HistoryApi

mouseMode

戻り値 ViewerMouseMode

引数

value: ViewerMouseMode

戻り値 any

pageCount

戻り値 number

renderMode

戻り値 ViewerRenderMode

引数

mode: ViewerRenderMode

戻り値 any

reportLoaded

戻り値 EventFan < ReportLoadEventArgs >

stateChanged

戻り値 EventFan < ChangedEventArgs >

toolbar

戻り値 Toolbar

viewMode

戻り値 ViewerViewMode | ViewMode

引数

value: ViewerViewMode | ViewMode

戻り値 any

zoom

戻り値 ViewerZoomMode

引数

value: ViewerZoomMode

戻り値 any

コンストラクタ

constructor

引数

element: any

オプション options: ViewerOptions

戻り値 Viewer

メソッド

backToParent

戻り値 void

canBackToParent

戻り値 boolean

dispose

戻り値 void

export

引数

format: string

settings: Record<string, string | boolean | number>

オプション params: undefined | { cancel?: undefined | ((): boolean ) }

戻り値 Promise < ExportResult >

goToFirstPage

戻り値 void

goToLastPage

戻り値 void

goToNextPage

戻り値 void

goToPage

引数

pageNumber: number

戻り値 void

goToPrevPage