Wijmo_Viewer.Reportviewer

ReportViewer クラス

FlexReportまたはSSRSレポートを表示するReportViewerコントロールを定義します。

serviceUrl プロパティは、レポートサービスを提供するC1 Web APIのURLを示します。レポートサービスは、C1FlexReportを使用してFlexReportを処理し、C1SSRSDocumentSourceとC1PdfDocumentSourceを使用してSSRSレポートを処理します。

次に、FlexReportを表示する方法のサンプルを示します。

import { ReportViewer } from '@grapecity/wijmo.viewer';
var reportViewer = new ReportViewer('#reportViewer');
reportViewer.serviceUrl = 'http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report';
reportViewer.filePath = 'ReportsRoot/Formatting/AlternateBackground.flxr';
reportViewer.reportName = 'AlternateBackground';

次に、SSRSレポートを表示する方法のサンプルを示します。

import { ReportViewer } from '@grapecity/wijmo.viewer';
var reportViewer = new ReportViewer('#reportViewer');
reportViewer.serviceUrl = 'http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report';
reportViewer.filePath = 'c1ssrs/AdventureWorks/Company Sales';

階層

ViewerBase
- ReportViewer
  - WjReportViewer

コンストラクタ

constructor

プロパティ

メソッド

イベント

コンストラクタ

constructor

new ReportViewer(element: any, options?: any): ReportViewer

オーバーライド ViewerBase.constructor

ReportViewer クラスの新しいインスタンスを初期化します。

引数
- element: any
  
  コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。
- オプション options: any
  
  コントロールの初期化データを含むJavaScriptオブジェクト。
戻り値 ReportViewer

プロパティ

filePath

filePath: string

サーバー上のドキュメントの完全パスを取得または設定します。

パスは、指定されたドキュメントをロードするためにサーバーに登録されているプロバイダのキーで始まります。

fullScreen

fullScreen: boolean

ビューアが全画面表示モードかどうかを示す値を取得または設定します。

hostElement

hostElement: HTMLElement

コントロールをホストしているDOM要素を取得します。

isDisabled

isDisabled: boolean

コントロールが無効かどうかを判定する値を取得または設定します。

無効化されたコントロールは、マウスイベントやキーボードイベントを取得できません。

isTouching

isTouching: boolean

現在、コントロールがタッチイベントを処理しているかどうかを示す値を取得します。

isUpdating

isUpdating: boolean

コントロールが現在更新中かどうかを示す値を取得します。

mouseMode

mouseMode: MouseMode

マウスの動作を示す値を取得または設定します。

デフォルトはSelectToolです。その場合は、マウスでクリックしてドラッグすると、テキストが選択されます。

pageIndex

pageIndex: number

ビューパネルに現在表示されているページのインデックスを取得します。

paginated

paginated: boolean

コンテンツを一連の固定サイズのページとして表すかどうかを示す値を取得または設定します。

デフォルト値はnullです。その場合、FlexReportではページ区切り付きモードが使用され、SSRSレポートではページ区切りなしモードが使用されます。

parameters

parameters: any

レポートの実行に使用するパラメータを記述する{name: value}ペアの辞書を取得または設定します。

このプロパティは、レポートで特定のパラメータ（たとえば、非表示のパラメータ）を初期段階で渡す必要がある場合に役に立ちます。

reportViewer.parameters = {
   'CustomerID': 'ALFKI'
};

reportName

reportName: string

レポート名を取得または設定します。

FlexReportの場合は、FlexReport定義ファイルに定義されたレポート名でこれを設定します。 SSRSレポートの場合は、これを空の文字列のままにしてください。SSRSレポートのパスは、filePath プロパティで指定します。

requestHeaders

requestHeaders: any

データを送信または要求するときに使用する要求ヘッダーを含むオブジェクトを取得または設定します。

このプロパティは、認証が必要なシナリオでよく使用されます。以下に例を示しています。

viewer.requestHeaders = {
    Authorization: 'Bearer ' + appAuthService.getToken();
};

rightToLeft

rightToLeft: boolean

要素内のコントロールを右から左のレイアウトでホストするかどうかを示す値を取得します。

selectMouseMode

selectMouseMode: boolean

非推奨になりました。代わりにmouseModeを使用してください。

serviceUrl

serviceUrl: string

C1 Web APIサービスのアドレスを取得または設定します。

例："http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report"。

thresholdWidth

thresholdWidth: number

モバイルテンプレートとPCテンプレートの切り替えに使用するしきい値を取得または設定します。

デフォルト値は767pxです。コントロールの幅がthresholdWidthより小さい場合は、モバイルテンプレートが適用されます。コントロールの幅がthresholdWidth以上の場合は、PCテンプレートが適用されます。 thresholdWidthを0に設定すると、PCテンプレートだけが適用されます。 9999などの大きな数字に設定すると、モバイルテンプレートだけが適用されます。

viewMode

viewMode: ViewMode

ドキュメントページの表示方法を示す値を取得または設定します。

zoomFactor

zoomFactor: number

ドキュメントページを表示する現在のズーム倍率を示す値を取得または設定します。

zoomMode

zoomMode: ZoomMode

ドキュメントページを表示する現在のズームモードを示す値を取得または設定します。

静的 controlTemplate

controlTemplate: string

ビューアコントロールのインスタンス化に使用されるテンプレートを取得または設定します。

メソッド

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void

継承元 Control.addEventListener

このControl が所有する要素にイベントリスナーを追加します。

コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、コントロールが破棄されているときにそれらを簡単に削除することができます（dispose と removeEventListener ) メソッドを参照してください）。

イベントリスナーを削除しないと、メモリリークが発生する可能があります。

デフォルトでは passive パラメータはfalseに設定されています。これはイベントハンドラが event.preventDefault() を呼び出すことを意味します。タッチイベントまたはマウスホイールイベントにpassiveハンドラを追加する場合は、このパラメータをtrueに設定するとアプリケーションのパフォーマンスが向上します。

passive　イベントリスナーの詳細については、「Improving scrolling performance with passive listeners」を参考してください。

引数
- target: EventTarget
  
  イベントのターゲット要素。
- type: string
  
  イベントを指定する文字列。
- fn: any
  
  イベントが発生したときに実行する関数。
- オプション capture: boolean
  
  リスナーがターゲット要素によって処理される前にコントロールによって処理される必要があるかどうかを示します。
- オプション passive: boolean
  
  ハンドラーが preventDefault() を呼び出さないことを示します。
戻り値 void

applyTemplate

applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

継承元 Control.applyTemplate
コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。

このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出され、テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。以下のサンプルコードは、InputNumber コントロールのインスタンスにテンプレートを適用します。このテンプレートには、'wj-part'属性が'input'、'btn-inc'、および'btn-dec'に設定された要素を含める必要があります。コントロールのメンバである'_tbx'、'_btnUp'、'_btnDn'には、これらの要素への参照が割り当てられます。
```
this.applyTemplate('wj-control wj-inputnumber', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');
```
引数
- classNames: string
  
  コントロールのホスト要素に追加するクラスの名前。
- template: string
  
  コントロールのテンプレートを定義するHTML文字列。
- parts: Object
  
  パーツ変数とその名前のディクショナリー。
- オプション namePart: string
  
  ホスト要素にちなんで名付けられたパーツの名前。これにより、コントロールがフォームで使用されたときにデータをどのように送信するかが決まります。
戻り値 HTMLElement

beginUpdate

beginUpdate(): void

継承元 Control.beginUpdate

次にendUpdate が呼び出されるまで通知を中断します。

戻り値 void

containsFocus

containsFocus(): boolean

継承元 Control.containsFocus

このコントロールにフォーカスのある要素が含まれているかどうかをチェックします。

戻り値 boolean

deferUpdate

deferUpdate(fn: Function): void

継承元 Control.deferUpdate

beginUpdate/endUpdate ブロック内で関数を実行します。

この関数の実行が完了するまでコントロールは更新されません。このメソッドは、関数が例外を生成した場合でも endUpdate が呼び出されるようにします。

引数
- fn: Function
  
  実行する関数。
戻り値 void

dispose

dispose(): void

継承元 Control.dispose

ホスト要素との関連付けを解除することによってコントロールを破棄します。

dispose メソッドは、addEventListener メソッドによって追加されたイベントリスナーを自動的に削除します。

コントロールを動的に作成および削除するアプリケーションでは、 dispose メソッドを呼び出すことが重要です。コントロールを破棄しないと、メモリリークが発生する可能があります。.

戻り値 void

endUpdate

endUpdate(): void

継承元 Control.endUpdate

beginUpdate の呼び出しによって中断された通知を再開します。

戻り値 void

focus

focus(): void

継承元 Control.focus

このコントロールにフォーカスを設定します。

戻り値 void

getTemplate

getTemplate(): string

継承元 Control.getTemplate

コントロールのインスタンスの作成に使用されたHTMLテンプレートを取得します。

このメソッドは、クラス階層をさかのぼってコントロールのテンプレートを指定する最も近い祖先を探します。たとえば、ComboBox コントロールのプロトタイプを指定した場合、そのプロトタイプによってDropDown 基本クラスで定義されたテンプレートがオーバーライドされます。

戻り値 string

hasOwnProperty

hasOwnProperty(v: PropertyKey): boolean

継承元 Object.hasOwnProperty

オブジェクトが指定されたプロパティを持つかどうかを判定します。

引数
- v: PropertyKey
  
  プロパティの名前。
戻り値 boolean

initialize

initialize(options: any): void

継承元 Control.initialize
指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。

このメソッドを使用すると、各プロパティの値をコードで設定する代わりにプレーンなデータオブジェクトを使用してコントロールを初期化できます。

例:
```
grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 }
  ]
});
// これは以下と同等です。
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// など
```
初期化データは適用時に型チェックされます。初期化オブジェクトに不明なプロパティ名または無効なデータ型が含まれている場合、このメソッドは例外をスローします。
引数
- options: any
  
  初期化データを含むオブジェクト。
戻り値 void

invalidate

invalidate(fullUpdate?: boolean): void

継承元 Control.invalidate

非同期更新を発生させるため、コントロールを無効にします。

引数
- オプション fullUpdate: boolean
  
  内容だけでなくコントロールのレイアウトも更新するかどうか。
戻り値 void

isPrototypeOf

isPrototypeOf(v: Object): boolean

継承元 Object.isPrototypeOf

オブジェクトが別のオブジェクトのプロトタイプチェーンに存在するかどうかを判定します。

引数
- v: Object
  
  プロトタイプチェーンが判定される別のオブジェクト。
戻り値 boolean

moveToPage

moveToPage(index: number): IPromise

継承元 ViewerBase.moveToPage

指定したインデックスにあるページに移動します。

引数
- index: number
  
  移動先のページの0から始まるインデックス。
戻り値 IPromise

onBeforeSendRequest

onBeforeSendRequest(e: RequestEventArgs): void

継承元 ViewerBase.onBeforeSendRequest

beforeSendRequest イベントを発生させます。

引数
- e: RequestEventArgs
  
  RequestEventArgs オブジェクト。
戻り値 void

onFullScreenChanged

onFullScreenChanged(e?: EventArgs): void

継承元 ViewerBase.onFullScreenChanged

fullScreenChanged イベントを発生させます。

引数
- オプション e: EventArgs
  
  EventArgs オブジェクト。
戻り値 void

onGotFocus

onGotFocus(e?: EventArgs): void

継承元 Control.onGotFocus

gotFocus イベントを発生させます。

引数
- オプション e: EventArgs
戻り値 void

onLostFocus

onLostFocus(e?: EventArgs): void

継承元 Control.onLostFocus

lostFocus イベントを発生させます。

引数
- オプション e: EventArgs
戻り値 void

onMouseModeChanged

onMouseModeChanged(e?: EventArgs): void

継承元 ViewerBase.onMouseModeChanged

mouseModeChanged イベントを発生させます。

引数
- オプション e: EventArgs
  
  EventArgs オブジェクト。
戻り値 void

onPageIndexChanged

onPageIndexChanged(e?: EventArgs): void

継承元 ViewerBase.onPageIndexChanged

pageIndexChanged イベントを発生させます。

引数
- オプション e: EventArgs
  
  EventArgs オブジェクト。
戻り値 void

onRefreshed

onRefreshed(e?: EventArgs): void

継承元 Control.onRefreshed

refreshed イベントを発生させます。

引数
- オプション e: EventArgs
戻り値 void

onRefreshing

onRefreshing(e?: EventArgs): void

継承元 Control.onRefreshing

refreshing イベントを発生させます。

引数
- オプション e: EventArgs
戻り値 void

onSelectMouseModeChanged

onSelectMouseModeChanged(e?: EventArgs): void

継承元 ViewerBase.onSelectMouseModeChanged

非推奨になりました。代わりにonMouseModeChangedを使用してください。

引数
- オプション e: EventArgs
  
  EventArgs オブジェクト。
戻り値 void

onViewModeChanged

onViewModeChanged(e?: EventArgs): void

継承元 ViewerBase.onViewModeChanged

viewModeChanged イベントを発生させます。

引数
- オプション e: EventArgs
  
  EventArgs オブジェクト。
戻り値 void

onZoomFactorChanged

onZoomFactorChanged(e?: EventArgs): void

継承元 ViewerBase.onZoomFactorChanged

zoomFactorChanged イベントを発生させます。

引数
- オプション e: EventArgs
  
  EventArgs オブジェクト。
戻り値 void

propertyIsEnumerable

propertyIsEnumerable(v: PropertyKey): boolean

継承元 Object.propertyIsEnumerable

指定されたプロパティが列挙可能かどうかを判断します。

引数
- v: PropertyKey
  
  プロパティの名前。
戻り値 boolean

reload

reload(): void

継承元 ViewerBase.reload

ドキュメントを再ロードします。

これは、ドキュメントを強制的に再ロードおよび再レンダリングする場合に便利です。

戻り値 void

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

継承元 Control.removeEventListener

このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。

引数
- オプション target: EventTarget
  
  イベントのターゲット要素。 nullの場合、すべてのターゲットにアタッチされているリスナーが解除されます
- オプション type: string
  
  イベントを指定する文字列。 nullの場合、すべてのイベントにアタッチされているリスナーが解除されます。
- オプション fn: any
  
  削除するハンドラ。 nullの場合は、すべてのハンドラが削除されます。
- オプション capture: boolean
  
  リスナーがキャプチャリスナーかどうか。 nullの場合、キャプチャリスナーと非キャプチャリスナーの両方が解除されます。
戻り値 number

showPageSetupDialog

showPageSetupDialog(): void

継承元 ViewerBase.showPageSetupDialog

ページ設定ダイアログボックスを表示します。

戻り値 void

toLocaleString

toLocaleString(): string

継承元 Object.toLocaleString

現在のロケールを使用して文字列に変換された日付を返します。

戻り値 string

toString

toString(): string

継承元 Object.toString

オブジェクトの文字列表現を返します。

戻り値 string

valueOf

valueOf(): Object

継承元 Object.valueOf

指定されたオブジェクトのプリミティブ値を返します。

戻り値 Object

zoomToView

zoomToView(): void

継承元 ViewerBase.zoomToView

現在のページを拡大縮小して、ビューパネルにページ全体を表示します。

戻り値 void

zoomToViewWidth

zoomToViewWidth(): void

継承元 ViewerBase.zoomToViewWidth

ビューパネルの幅に合わせて現在のページを拡大縮小します。

戻り値 void

静的 disposeAll

disposeAll(e?: HTMLElement): void

継承元 Control.disposeAll

HTML要素に含まれるすべてのWijmoコントロールを破棄します。

引数
- オプション e: HTMLElement
  
  コンテナー要素。
戻り値 void

静的 getControl

getControl(element: any): Control

継承元 Control.getControl

指定したDOM要素でホストされているコントロールを取得します。

引数
- element: any
  
  コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。
戻り値 Control

静的 getReportNames

getReportNames(serviceUrl: string, reportFilePath: string, httpHandler?: IHttpRequestHandler): IPromise

指定されたFlexReport定義ファイルに定義されたレポート名を取得します。

引数
- serviceUrl: string
  
  C1 Web APIサービスのアドレス。
- reportFilePath: string
  
  FlexReport定義ファイルの完全パス。
- オプション httpHandler: IHttpRequestHandler
  
  HTTPリクエストハンドラ。このパラメータはオプションです。
戻り値 IPromise

静的 getReports

getReports(serviceUrl: string, path: string, data?: any, httpHandler?: IHttpRequestHandler): IPromise

指定されたフォルダパス内のカタログ項目を取得します。

次のデータパラメータを渡すことで、フォルダパスの下のすべての項目を取得できます。 1) true値。 2) true値を含む"recursive"プロパティを持つオブジェクト。

引数
- serviceUrl: string
  
  C1 Web APIサービスのアドレス。
- path: string
  
  フォルダパス。 FlexReport定義ファイルのパスは、フォルダパスとして扱われます。
- オプション data: any
  
  レポートサービスに送られる要求データ、またはパス下のすべての項目を取得するかどうかを示すboolean値。
- オプション httpHandler: IHttpRequestHandler
  
  HTTPリクエストハンドラ。このパラメータはオプションです。
戻り値 IPromise

静的 invalidateAll

invalidateAll(e?: HTMLElement): void

継承元 Control.invalidateAll

指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。

このメソッドは、コントロールの表示状態やサイズを変更する動的なパネルをアプリケーションで使用している場合に使用します。たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、それらのコントロールが適切に機能しなくなる可能性があります。これが起こる場合は、動的コンテナーで適切なイベントを処理し、 Control.invalidateAll メソッドを呼び出してコンテナー内のWijmoコントロールのレイアウト情報が適切に更新されるようにする必要があります。

引数
- オプション e: HTMLElement
  
  コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。
戻り値 void

静的 refreshAll

refreshAll(e?: HTMLElement): void

継承元 Control.refreshAll

HTML要素で存在するすべてのWijmoコントロールを更新する。

コントロールが時間おいて更新される代わりに直ちに更新されること以外はinvalidateAll メソッドと同様です。

引数
- オプション e: HTMLElement
  
  コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。
戻り値 void

イベント

beforeSendRequest

beforeSendRequest: Event

各要求がサーバーに送信される前に発生します。

このイベントでは、サーバーに送信する前に、URL、ヘッダー、データなどのリクエストオプションに加えてリクエストメソッドも変更できます。このイベントは、RequestEventArgs 型の引数を渡します。そのプロパティは、wijmo.httpRequest メソッドのパラメータと同じ意味と構造を持ち、要求属性を更新するように変更できます。

たとえば、認証トークンを 'Authorization'ヘッダーに入れることができます。

viewer.beforeSendRequest.addHandler((s, e) => {
    e.settings.requestHeaders.Authorization = 'Bearer ' + appAuthService.getToken();
});

ブラウザで自動的に（たとえば、URLがwindow.open() 関数へのパラメータとして、またはHTMLリンクとして使用される場合）実行されるHTTP要求が誘導するためにURLが使用されている場合、 e.settings引数はnullになります。

fullScreenChanged

fullScreenChanged: Event

全画面表示モードが変更された後に発生します。

gotFocus

gotFocus: Event

コントロールがフォーカスを取得したときに発生します。

lostFocus

lostFocus: Event

コントロールがフォーカスを失ったときに発生します。

mouseModeChanged

mouseModeChanged: Event

マウスモードが変更された後に発生します。

pageIndexChanged

pageIndexChanged: Event

ページインデックスが変更された後に発生します。

queryLoadingData

queryLoadingData: Event

ドキュメントのロード前に、サービスに送られる要求データをクエリーしたときに発生します。

refreshed

refreshed: Event

コントロールが内容を更新した後で発生します。

refreshing

refreshing: Event

コントロールが内容を更新する直前に発生します。

selectMouseModeChanged

selectMouseModeChanged: Event

非推奨になりました。代わりにmouseModeChangedを使用してください。

viewModeChanged

viewModeChanged: Event

ビューモードが変更された後に発生します。

zoomFactorChanged

zoomFactorChanged: Event

ズーム倍率が変更された後に発生します。

Wijmo_Viewer.Reportviewer

ReportViewer クラス

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

引数

element: any

オプション options: any

戻り値 ReportViewer

プロパティ

filePath

fullScreen

hostElement

isDisabled

isTouching

isUpdating

mouseMode

pageIndex

paginated

parameters

reportName

requestHeaders

rightToLeft

selectMouseMode

serviceUrl

thresholdWidth

viewMode

zoomFactor

zoomMode

静的 controlTemplate

メソッド

addEventListener

引数

target: EventTarget

type: string

fn: any

オプション capture: boolean

オプション passive: boolean

戻り値 void

applyTemplate

引数

classNames: string

template: string

parts: Object

オプション namePart: string

戻り値 HTMLElement

beginUpdate

戻り値 void

containsFocus

戻り値 boolean

deferUpdate

引数

fn: Function

戻り値 void

dispose

戻り値 void

endUpdate

戻り値 void

focus

戻り値 void

getTemplate

戻り値 string

hasOwnProperty

引数

v: PropertyKey

戻り値 boolean

initialize

引数

options: any

戻り値 void

invalidate

引数

オプション fullUpdate: boolean

戻り値 void

isPrototypeOf

引数