ReportViewer.Viewer

クラス: Viewer

ReportViewer.Viewer

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

コンストラクタ

constructor

アクセサ

メソッド

コンストラクタ

constructor

• new Viewer(element, options?)

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`	コントロール設定。

アクセサ

availableExports

• get availableExports(): string[]

ビューアに接続されているプラグインをエクスポートする際、エクスポートパネルに表示するリストを設定します。

viewer.availableExports = [''] //disable all loaded export modules
viewer.availableExports = ['pdf'] //filters out any export formats other than PDF
viewer.availableExports = [] //enable all loaded export modules

戻り値

string[]

• set availableExports(formatKeys): void

ビューアに接続されているプラグインをエクスポートする際、エクスポートパネルに表示するリストを設定します。

viewer.availableExports = [''] //disable all loaded export modules
viewer.availableExports = ['pdf'] //filters out any export formats other than PDF
viewer.availableExports = [] //enable all loaded export modules

パラメータ

名前	型
`formatKeys`	`string`[]

戻り値

void

currentPage

• get currentPage(): number

現在のページ番号を取得します。ドキュメントが読み込まれていない場合は0を返します。

var pageNumber = viewer.currentPage;

戻り値

number

documentLoaded

• get documentLoaded(): Event<DocumentLoadEventArgs>

ドキュメントがビューアに描画されたり、更新された場合に発生するdocumentLoadedイベントを設定します。

type DocumentLoadedEventArgs = {
    pageCount: number;
    cancelled?: boolean;
}

viewer.documentLoaded.register(args => console.log('Report was fully rendered ', args));

戻り値

Event<DocumentLoadEventArgs>

errorHandler

• get errorHandler(): ErrorHandler

ビューアのエラーハンドラを取得または設定します。ユーザーがエラー出力をカスタマイズしたい場合、既存のエラーを上書きして表示しないようにします。

type ErrorMessage = {
    severity: "error" | "warn" | "info" | "debug";
    message: string,
    details: string);

function handler(error: ErrorMessage){
    console.log(error.message);
    return true; // return true if you don't want to show this error in viewer's error pane
}

viewer.errorHandler = handler;

戻り値

ErrorHandler

• set errorHandler(handler): void

type ErrorMessage = {
    severity: "error" | "warn" | "info" | "debug";
    message: string,
    details: string);

function handler(error: ErrorMessage){
    console.log(error.message);
    return true; // return true if you don't want to show this error in viewer's error pane
}

viewer.errorHandler = handler;

Parameters

名前	型
`handler`	`ErrorHandler`

戻り値

void

history

• get history(): HistoryApi

"history"APIへのアクセスを提供します。

戻り値

HistoryApi

mouseMode

• get mouseMode(): ViewerMouseMode

ビューアのマウスモードを取得または設定する。利用可能な値は次の通り： Pan | Selection.

viewer.mouseMode = "pan";

戻り値

ViewerMouseMode

• set mouseMode(value): void

ビューアのマウスモードを取得または設定する。利用可能な値は次の通り：Pan | Selection.

viewer.mouseMode = "pan";

パラメータ

名前	型
`value`	`ViewerMouseMode`

戻り値

void

pageCount

• get pageCount(): number

レポートで利用可能な総ページ数を取得します。

var totalPages = viewer.pageCount;

戻り値

number

renderMode

• get renderMode(): ViewerRenderMode

ビューアのレンダリングモードを取得または設定します。利用可能な値は次の通り： Galley | Paginated

viewer.renderMode = 'Galley';

戻り値

ViewerRenderMode

• set renderMode(mode): void

ビューアのレンダリングモードを取得または設定します。利用可能な値は次の通り：Galley | Paginated

viewer.renderMode = 'Galley';

パラメータ

名前	型
`mode`	`ViewerRenderMode`

戻り値

void

reportLoaded

• get reportLoaded(): Event<ReportLoadEventArgs>

レポートがビューアにロードされると発生するreportLoadedイベントを設定します。ただし、ドリルスルーレポートは考慮されていません。

 type ReportLoadEventArgs = {
    report: PageReport;
}

viewer.reportLoaded.register(args => console.log('Report just loaded ', args));

戻り値

Event<ReportLoadEventArgs>

showParametersOnOpen

• get showParametersOnOpen(): ShowParametersOnOpen

パラメータパネルの動作を取得または設定します。

viewer.showParametersOnOpen = 'always';

戻り値

ShowParametersOnOpen

• set showParametersOnOpen(mode): void

パラメータパネルの動作を取得または設定します。

viewer.showParametersOnOpen = 'always';

パラメータ

名前	型
`mode`	`ShowParametersOnOpen`

戻り値

void

stateChanged

• get stateChanged(): Event<ChangedEventArgs>

ビューアの状態が変更されたことを示すイベントを取得または設定します。この変更には、視覚的な設定や、ドキュメントの描画などコンテンツの変更が含まれます。

戻り値

Event<ChangedEventArgs>

theme

• get theme(): undefined | BuiltInUITheme

UIテーマを取得します。

戻り値

undefined | BuiltInUITheme

• set theme(value): void

Uiテーマを設定します。

パラメータ

名前	型
`value`	`undefined` \| `BuiltInUITheme`

戻り値

void

• get toolbar(): Toolbar

ビューアのツールバーを取得します。

戻り値

Toolbar

viewMode

• get viewMode(): ViewerViewMode | ViewMode

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

enum ViewMode {
    SinglePage = 0,
    ContinousPage = 1
}
var viewMode = viewer.viewMode //by default SinglePage
//set to continous
viewer.viewMode = 'continuous' // or viewer.viewMode = 1;

戻り値

ViewerViewMode | ViewMode

• set viewMode(value): void

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

enum ViewMode {
    SinglePage = 0,
    ContinousPage = 1
}
var viewMode = viewer.viewMode //by default SinglePage
//set to continous
viewer.viewMode = 'continuous' // or viewer.viewMode = 1;

パラメータ

名前	型
`value`	`ViewerViewMode` \| `ViewMode`

戻り値

void

zoom

• get zoom(): ViewerZoomMode

現在のズーム値を取得または設定します。ズーム値は指定できます。利用可能な値は次の通り：

0～3： 0.5は50％、および3は300％の表示倍率を示します。
定数値 'FitToWidth' | 'FitPage'

var currentZoom = viewer.zoom; //by default 1 (100%)
//now set mode to Fit to Width
viewer.zoom = 'FitToWidth';
//now verify value
var newValue = viewer.zoom;
//newValue will be equal to FitToWidth

戻り値

ViewerZoomMode

• set zoom(value): void

現在のズーム値を取得または設定します。ズーム値は指定できます。利用可能な値は次の通り：

0～3： 0.5は50％、および3は300％の表示倍率を示します。
定数値 'FitToWidth' | 'FitPage'

var currentZoom = viewer.zoom; //by default 1 (100%)
//now set mode to Fit to Width
viewer.zoom = 'FitToWidth';
//now verify value
var newValue = viewer.zoom;
//newValue will be equal to FitToWidth

パラメータ

名前	型
`value`	`ViewerZoomMode`

戻り値

void

メソッド

backToParent

▸ backToParent(): void

親レポートをビューワに表示します。

viewer.backToParent();

戻り値

void

canBackToParent

▸ canBackToParent(): boolean

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

戻り値

boolean

dispose

▸ dispose(): void

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

戻り値

void

export

▸ export(format, settings, params?): Promise<ExportResult>

レポートを指定した形式にエクスポートします。結果をblobオブジェクトまたは文字列としてダウンロードできる関数を含めて返します。そのためこのblobオブジェクトを使用するか、ファイルを直接ダウンロードすることができます。PDF設定はリストとして設定可能です。（例：**{title: 'Title', author: 'Author Name', ownerPassword: '1'）**など...

var options = {filename:"Invoice List"};
var cancelCallback = function(){
    return false; // continue export. Return true to cancel export process
}
viewer.export('pdf', options, {cancel: cancelCallback }).then(result => doSmthWithBlob(result.data));
//or you can download file
viewer.export('pdf', options, {cancel: cancelCallback }).then(result => result.download('Invoice List'));

パラメータ

名前	型	説明
`format`	`string`	次の形式でエクスポート可能です。'pdf', 'xlsx','html'.
`settings`	`Record`<`string`, `string` \| `number` \| `boolean`>	形式毎のエクスポート設定。
`params?`	`Object`	追加のエクスポートのカスタマイズ。
`params.cancel?`	() => `boolean`	-

戻り値

Promise<ExportResult>

goToFirstPage

▸ goToFirstPage(): void

ドキュメントの最初のページに移動します。

viewer.goToFirstPage();

戻り値

void

goToLastPage

▸ goToLastPage(): void

ドキュメントの最後のページに移動します。

viewer.goToLastPage();

戻り値

void

goToNextPage

▸ goToNextPage(): void

ドキュメントの次のページに移動します。

viewer.goToNextPage();

戻り値

void

goToPage

▸ goToPage(pageNumber): void

指定したページに移動します。

viewer.goToPage(3); //will navigate to 3d page

パラメータ

名前	型
`pageNumber`	`number`

戻り値

void

goToPrevPage

▸ goToPrevPage(): void

ドキュメントの前のページに移動します。

viewer.goToPrevPage();

戻り値

void

highlight

▸ highlight(result): 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`	`null` \| `SearchResult`

戻り値

Promise<void>

open

▸ open(report, settings?): Promise<LoadResult>

レポート定義ファイルからレポートを開きます。jsonをレポートとして読み込むことも可能です。

var viewer = new ActiveReports.Viewer(#viewerPlace);
viewer.open('report.json');

パラメータ

名前	型	説明
`report`	`string` \| `PageReport` \| `Report`	レポートテンプレート。レポートURI、レポート定義、またはPageReportクラスのインスタンスです。
`settings?`	`Partial`<`ReportSettings`>	レポートの追加設定（名前、レポートパラメータなど）。

戻り値

Promise<LoadResult>

print

▸ print(): void

現在開いているレポートを印刷します。

viewer.print();

戻り値

void

refresh

▸ refresh(): void

レポートを再描画します。

viewer.refresh();

戻り値

void

resetDocument

▸ resetDocument(): Promise<void>

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

戻り値

Promise<void>

search

▸ search(options, resultFn, progressFn?, cancel?): Promise<SearchStatus>

現在開いているレポートで指定した文字列を検索検索を実行します。また、独自のカスタム検索パネルを作成することが可能です。

viewer.search({
    text: "Ship",
    matchCase: true
}, function(result){
    console.log(result)
}, function(progress){
    console.log(progress)
})

パラメータ

名前	型
`options`	`SearchOptions`
`resultFn`	(`result`: `SearchResult`) => `void`
`progressFn?`	(`progress`: { `pageCount`: `null` \| `number` ; `pageIndex`: `number` }) => `void`
`cancel?`	`CancellationToken`

戻り値

Promise<SearchStatus>

toggleFullScreen

▸ toggleFullScreen(enabled?): void

ビューワをフルスクリーンモードで起動します。

viewer.toggleFullScreen();

パラメータ

名前	型
`enabled?`	`boolean`

戻り値

void

toggleSidebar

▸ toggleSidebar(visible?): void

サイドバーパネルの表示/非表示を切り替えます。レポートパラメータがコードで渡されない場合、サイドバーで設定可能です。

viewer.toggleSidebar(); //will hide toolbar if visible
viewer.toggleSidebar(true);//will show it regardless current state

パラメータ

名前	型	説明
`visible?`	`boolean`	新しく表示する時の状態。値は渡されない場合、関数が現在の状態を切り替えます。

戻り値

void

toggleToolbar

▸ toggleToolbar(show?): void

ツールバーの表示/非表示を切り替えます。

viewer.toggleToolbar(); // toggles toolbar visibility
viewer.toggleToolbar(true); //will show it

パラメータ

名前	型	説明
`show?`	`boolean`	trueを設定した場合、ツールバーが表示されます。ツールバーの展開／縮小を切り替えるために値を渡さないでください。

戻り値

void

ReportViewer.Viewer

クラス: Viewer

Table of contents

コンストラクタ

アクセサ

メソッド

コンストラクタ

constructor

パラメータ

アクセサ

availableExports

戻り値

パラメータ

戻り値

currentPage

戻り値

documentLoaded

戻り値

errorHandler

戻り値

Parameters

戻り値

history

戻り値

mouseMode

戻り値

パラメータ

戻り値

pageCount

戻り値

renderMode

戻り値

パラメータ

戻り値

reportLoaded

戻り値

showParametersOnOpen

戻り値

パラメータ

戻り値

stateChanged

戻り値

theme

戻り値

パラメータ

戻り値

toolbar

戻り値

viewMode

戻り値

パラメータ

戻り値

zoom

戻り値

パラメータ

戻り値

メソッド

backToParent

戻り値

canBackToParent

戻り値

dispose

戻り値

export

パラメータ

戻り値

goToFirstPage

戻り値

goToLastPage

戻り値

goToNextPage

戻り値

goToPage

パラメータ

戻り値

goToPrevPage

戻り値

highlight

パラメータ

戻り値