ReportViewer.Viewer

Class: Viewer

ReportViewer.Viewer

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

コンストラクタ

constructor

アクセサー

メソッド

Constructors

constructor

• new Viewer(element, options?)

id='viewer'でコンテナのdiv要素にビューワを作成し、言語を設定します。

var options = { language: 'ru' };
var viewer = new ActiveReports.Viewer('#viewer', options );
viewer.open('report.json');

Parameters

Name	Type	Description
`element`	`any`	Where to render the viewer control. Accepts on of the following values: - string: DOM selector of the element to render viewer to. E.g. '#viewer' - DOM Element. E.g. document.getElementById('viewer') - JQuery object. E.g. $('#viewer')
`options?`	`ViewerOptions`	コントロールの設定。

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:989

Accessors

availableExports

• get availableExports(): string[]

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

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

Returns

string[]

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1199

• set availableExports(formatKeys): void

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

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

Parameters

Name	Type
`formatKeys`	`string`[]

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1200

currentPage

• get currentPage(): number

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

var pageNumber = viewer.currentPage;

Returns

number

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1178

documentLoaded

• get documentLoaded(): EventFan<DocumentLoadEventArgs>

ビューワにレポートが完全に描画されたときに発生するdocumentLoadedイベントを設定および登録します。再描画するときも動作します。

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

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

Returns

EventFan<DocumentLoadEventArgs>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1301

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;

Returns

ErrorHandler

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1105

• 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

Name	Type
`handler`	`ErrorHandler`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1106

history

• get history(): HistoryApi

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

Returns

HistoryApi

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1188

mouseMode

• get mouseMode(): ViewerMouseMode

ビューワのマウスモードを取得または設定します。パンモード（Pan）や選択モード（Selection）から選択できます。

viewer.mouseMode = "pan";

Returns

ViewerMouseMode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1085

• set mouseMode(value): void

ビューワのマウスモードを取得または設定します。パンモード（Pan）や選択モード（Selection）から選択できます。

viewer.mouseMode = "pan";

Parameters

Name	Type
`value`	`ViewerMouseMode`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1086

pageCount

• get pageCount(): number

レポートにおけるページの合計数を取得します。

var totalPages = viewer.pageCount;

Returns

number

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1186

renderMode

• get renderMode(): ViewerRenderMode

ビューワでページの表示モードを取得また設定します。通常モード（Paginated）、あるいはゲラモード（Galley）の2種類で表示できます。

viewer.renderMode = 'Galley';

Returns

ViewerRenderMode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1045

• set renderMode(mode): void

ビューワでページの表示モードを取得また設定します。通常モード（Paginated）、あるいはゲラモード（Galley）の2種類で表示できます。

viewer.renderMode = 'Galley';

Parameters

Name	Type
`mode`	`ViewerRenderMode`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1046

reportLoaded

• get reportLoaded(): EventFan<ReportLoadEventArgs>

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

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

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

Returns

EventFan<ReportLoadEventArgs>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1288

stateChanged

• get stateChanged(): EventFan<ChangedEventArgs>

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

Returns

EventFan<ChangedEventArgs>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1111

• get toolbar(): Toolbar

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

Returns

Toolbar

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1007

viewMode

• get viewMode(): ViewerViewMode | ViewMode

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

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

Returns

ViewerViewMode | ViewMode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1060

• set viewMode(value): void

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

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

Parameters

Name	Type
`value`	`ViewerViewMode` \| `ViewMode`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1061

zoom

• get zoom(): 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と等しくなります。

Returns

ViewerZoomMode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1076

• set zoom(value): void

現在のズーム倍率を示す値を取得または設定します。設定できる値は以下の通りです。

0～3： 0.5は50％、および3は300％の表示倍率を示します。
**「FitToWidth」や「FitPage」**のような定数値（大文字／小文字の区別なし）

var currentZoom = viewer.zoom; //デフォルト値は 1（100%）です。
「ページ幅に合わせる」モードに設定します。
viewer.zoom = 'FitToWidth';
//値を検証します
var newValue = viewer.zoom;
//newValueはFitToWidthと等しくなります。

Parameters

Name	Type
`value`	`ViewerZoomMode`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1077

Methods

backToParent

▸ backToParent(): void

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

viewer.backToParent();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1160

canBackToParent

▸ canBackToParent(): boolean

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

Returns

boolean

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1170

dispose

▸ dispose(): void

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

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1347

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'));

Parameters

Name	Type	Description
`format`	`string`	「pdf」、「xlsx」または「html」のいずれかの形式識別子にエクスポートします。
`settings`	`Record`<`string`, `string` \| `number` \| `boolean`>	形式に固有のエクスポート設定。
`params?`	`Object`	追加のエクスポートのカスタマイズ。
`params.cancel?`	() => `boolean`	-

Returns

Promise<ExportResult>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1218

goToFirstPage

▸ goToFirstPage(): void

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

viewer.goToFirstPage();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1120

goToLastPage

▸ goToLastPage(): void

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

viewer.goToLastPage();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1144

goToNextPage

▸ goToNextPage(): void

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

viewer.goToNextPage();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1136

goToPage

▸ goToPage(pageNumber): void

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

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

Parameters

Name	Type
`pageNumber`	`number`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1152

goToPrevPage

▸ goToPrevPage(): void

前のページに移動します。

viewer.goToPrevPage();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1128

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]);
}

Parameters

Name	Type
`result`	`null` \| `SearchResult`

Returns

Promise<void>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1345

open

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

「ファイル」からレポートを開き、またはjson文字列としてレポートを読み込みます。

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

Parameters

Name	Type	Description
`report`	`string` \| `PageReport` \| { `Name`: `string` ; `Type`: `"report"` } & { `Author`: `undefined` \| `string` ; `Body`: `undefined` \| `null` \| { `Name`: `string` ; `Type`: `"section"` } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; DataElementName?: string \| undefined; DataElementStyle?: DataElementStyle \| undefined; ... 17 more ...; Value?: RDLExpr<...> \| undefined; }) \| ... 19 more ... \| ( & ))[] \| undefined; St... ; `ConsumeContainerWhitespace`: `undefined` \| `boolean` ; `CustomProperties`: `undefined` \| { `Name`: `string` } & { Value?: RDLExpr<Variant> \| undefined; }[] ; `DataElementName`: `undefined` \| `string` ; `DataElementStyle`: `undefined` \| `ReportDataElementStyle` ; `DataSets`: `undefined` \| { `Name`: `string` } & { Filters?: ( & { FilterExpression?: RDLExpr<Variant> \| undefined; Operator?: FilterOperator \| undefined; FilterValues?: RDLExpr<Variant>[] \| undefined; })[] \| undefined; Fields?: ( & )[] \| undefined; Query?: ( & ) \| undefined; }[] ; `DataSources`: `undefined` \| { `Name`: `string` } & { Transaction?: boolean \| undefined; DataSourceReference?: string \| undefined; ConnectionProperties?: ( & { DataProvider?: string \| undefined; ConnectString?: string \| undefined; ... 4 more ...; WidthSensivity?: "Auto" \| ... 2 more ... \| undefined; }) \| undefined; }[] ; `Description`: `undefined` \| `string` ; `DocumentMap`: `undefined` \| & { Levels?: string[] \| undefined; Source?: "None" \| "Labels" \| "Headings" \| "All" \| undefined; NumberingStyle?: string \| undefined; } ; `EmbeddedImages`: `undefined` \| { `Name`: `string` } & { MIMEType?: string \| undefined; ImageData?: string \| undefined; }[] ; `FixedPage`: `undefined` \| `null` \| { `Name`: `string` ; `Type`: `"fixedpage"` } & { DataElementName?: string \| undefined; Pages?: ({ Type: "fixedpagesection"; } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; ... 19 more ...; Value?: RDLExpr<...> \| undefined; }) \| ... 19 more ... \| ( & ))[] \| undefined; Style?: ... ; `Language`: `undefined` \| `string` ; `Layers`: `undefined` \| { `Name`: `string` ; `Type`: `"layer"` } & { DesignerLock?: boolean \| undefined; DesignerTransparency?: number \| undefined; DesignerVisible?: boolean \| undefined; TargetDevice?: string \| undefined; }[] ; `LocalizationResources`: `undefined` \| & { Language?: string \| undefined; Data?: ({ Name: string; } & { Value?: RDLExpr<Variant> \| undefined; })[] \| undefined; }[] ; `Page`: `undefined` \| & { Style?: ( & { [x: string]: any; [x: number]: any; }) \| undefined; PageHeight?: string \| undefined; PageWidth?: string \| undefined; LeftMargin?: string \| undefined; RightMargin?: string \| undefined; TopMargin?: string \| undefined; BottomMargin?: string \| undefined; Columns?: number \| undefined; ColumnSpacing?: st... ; `PageFooter`: `undefined` \| `null` \| { `Name`: `string` ; `Type`: `"pagesection"` } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; DataElementName?: string \| undefined; DataElementStyle?: DataElementStyle \| undefined; ... 17 more ...; Value?: RDLExpr<...> \| undefined; }) \| ... 19 more ... \| ( & ))[] \| undefined; St... ; `PageHeader`: `undefined` \| `null` \| { `Name`: `string` ; `Type`: `"pagesection"` } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; DataElementName?: string \| undefined; DataElementStyle?: DataElementStyle \| undefined; ... 17 more ...; Value?: RDLExpr<...> \| undefined; }) \| ... 19 more ... \| ( & ))[] \| undefined; St... ; `ReportParameters`: `undefined` \| { `Name`: `string` } & { Multiline?: boolean \| undefined; DataType?: ReportParameterType \| undefined; Nullable?: boolean \| undefined; DefaultValue?: ( & { Values?: RDLExpr<Variant>[] \| undefined; }) \| ( & ) \| undefined; ... 6 more ...; SelectAllValue?: RDLExpr<...> \| undefined; }[] ; `StartPageNumber`: `undefined` \| `number` ; `ThemeUri`: `undefined` \| `string` ; `Width`: `undefined` \| `string` }	レポートテンプレートは、レポートURI、レポート定義、またはPageReportクラスのインスタンスになります。
`settings?`	`Partial`<`ReportSettings`>	レポートの追加設定（名前、パラメータ）。

Returns

Promise<LoadResult>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1005

print

▸ print(): void

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

viewer.print();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1274

refresh

▸ refresh(): void

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

viewer.refresh();

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1168

registerFont

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

deprecated Use FontStore.registerFonts instead.

指定されたフォントを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);
//OR
viewer.registerFont(arial, gothic);
//OR
var fonts = [arial, gothic]; viewer.registerFont(...fonts);

Parameters

Name	Type
`...fonts`	`FontDescriptor`[]

Returns

Promise<void>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1256

▸ registerFont(configUri): Promise<void>

deprecated Use FontStore.registerFonts instead.

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

Parameters

Name	Type
`configUri`	`string`

Returns

Promise<void>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1266

resetDocument

▸ resetDocument(): Promise<void>

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

Returns

Promise<void>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:993

search

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

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

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

Parameters

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

Returns

Promise<SearchStatus>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1316

toggleFullScreen

▸ toggleFullScreen(enabled?): void

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

viewer.toggleFullScreen();

Parameters

Name	Type
`enabled?`	`boolean`

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1037

toggleSidebar

▸ toggleSidebar(visible?): void

サイドバーの表示を切り替えます（表示または非表示にします）。パラメータが渡されない場合、トグルとして機能します。

viewer.toggleSidebar(); //ツールバーを非表示にします。
viewer.toggleSidebar(true);//ツールバーを表示します。

Parameters

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

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1018

toggleToolbar

▸ toggleToolbar(show?): void

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

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

Parameters

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

Returns

void

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1029

ReportViewer.Viewer

Class: Viewer

Table of contents

コンストラクタ

アクセサー

メソッド

Constructors

constructor

Parameters

Defined in

Accessors

availableExports

Returns

Defined in

Parameters

Returns

Defined in

currentPage

Returns

Defined in

documentLoaded

Returns

Defined in

errorHandler

Returns

Defined in

Parameters

Returns

Defined in

history

Returns

Defined in

mouseMode

Returns

Defined in

Parameters

Returns

Defined in

pageCount

Returns

Defined in

renderMode

Returns

Defined in

Parameters

Returns

Defined in

reportLoaded

Returns

Defined in

stateChanged

Returns

Defined in

toolbar

Returns

Defined in

viewMode

Returns

Defined in

Parameters

Returns

Defined in

zoom

Returns

Defined in

Parameters

Returns

Defined in

Methods

backToParent

Returns

Defined in

canBackToParent

Returns

Defined in

dispose

Returns

Defined in

export

Parameters