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

• availableExports: string[]

currentPage

• Readonly currentPage: number

diag

• Readonly diag: Object

型宣言

名前	型
`fetchPages`	(`startPageIndex?`: `number`, `count?`: `number`) => `void`
`processCommand`	(`cmd`: `ReportViewerCmd`) => `void`

documentLoaded

• Readonly documentLoaded: Event<DocumentLoadEventArgs>

errorHandler

• errorHandler: ErrorHandler

history

• Readonly history: HistoryApi

mouseMode

• mouseMode: ViewerMouseMode

pageCount

• Readonly pageCount: number

renderMode

• renderMode: ViewerRenderMode

reportLoaded

• Readonly reportLoaded: Event<ReportLoadEventArgs>

showParametersOnOpen

• showParametersOnOpen: ShowParametersOnOpen

stateChanged

• Readonly stateChanged: Event<ChangedEventArgs>

• Readonly toolbar: Toolbar

viewMode

• viewMode: ViewerViewMode | ViewMode

zoom

• zoom: ViewerZoomMode

メソッド

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; // エクスポートを続行します。エクスポート処理をキャンセルする場合、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` \| `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

指定したページに移動します。（1から始まる番号）

viewer.goToPage(3); // 3ページ目に移動します。

パラメータ

名前	型
`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

registerFont

▸ registerFont(...fonts): Promise<void>

deprecated FontStore.registerFonts を代わりに使用します。

指定されたフォントをCSSとPDFのエクスポートに登録します。これにより、フォントが無い環境でもエクスポートしたファイルが正しく表示されます。

type FontDescriptor = {
    name: string,
    source: string,
    weight?: 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900',
    style?: 'normal' | 'italic' | 'oblique'
}

var arial = {
    name: 'Arial',
    source: 'fonts/arial.ttf',
    style: 'italic',
    weight: '700',
};

var gothic = {
    name: 'MS PGothic',
    source: 'fonts/MS-PGothic.ttf'
};

viewer.registerFont(arial);
//または
viewer.registerFont(arial, gothic);
//または
var fonts = [arial, gothic]; viewer.registerFont(...fonts);

パラメータ

名前	型
`...fonts`	`FontDescriptor`[]

戻り値

Promise<void>

▸ registerFont(configUri): Promise<void>

deprecated FontStore.registerFonts を代わりに使用します。

viewer.registerFont('./fontsConfig.json');

パラメータ

名前	型
`configUri`	`string`

戻り値

Promise<void>

resetDocument

▸ resetDocument(): Promise<void>

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

戻り値

Promise<void>

search

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

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

viewer.search({
    text: "船",
    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(); // ツールバーを非表示にします。
viewer.toggleSidebar(true);// 現在の状態に関係なく表示されます。

パラメータ

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

戻り値

void

toggleToolbar

▸ toggleToolbar(show?): void

ツールバーの表示を切り替えます（表示または非表示にします）。

viewer.toggleToolbar(); // ツールバーの表示を切り替えます。
viewer.toggleToolbar(true); // ツールバーを表示します。

パラメータ

名前	型	説明
`show?`	`boolean`	ツールバーをオンにするために true を渡します、逆も同様です。表示を切り替えるために値を渡さないでください。

戻り値

void

ReportViewer.Viewer

クラス: Viewer

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

パラメータ

プロパティ

availableExports

currentPage

diag

型宣言

documentLoaded

errorHandler

history

mouseMode

pageCount

renderMode

reportLoaded

showParametersOnOpen

stateChanged

toolbar

viewMode

zoom

メソッド

backToParent

戻り値

canBackToParent

戻り値

dispose

戻り値

export

パラメータ

戻り値

goToFirstPage

戻り値

goToLastPage

戻り値

goToNextPage

戻り値

goToPage

パラメータ

戻り値

goToPrevPage

戻り値

highlight

パラメータ

戻り値

open

パラメータ

戻り値

print

戻り値

refresh

戻り値

registerFont

パラメータ

戻り値

パラメータ

戻り値

resetDocument

戻り値

search

パラメータ

戻り値

toggleFullScreen

パラメータ

戻り値

toggleSidebar

パラメータ

戻り値

toggleToolbar

パラメータ

戻り値