constructor(element: any, options?: any): ReportViewer
ReportViewerクラスの新しいインスタンスを初期化します。
The DOM element that will host the control, or a CSS selector for the host element (e.g. '#theCtrl').
JavaScript object containing initialization data for the control.
サーバー上のドキュメントの完全パスを取得または設定します。
パスは、指定されたドキュメントをロードするためにサーバーに登録されているプロバイダのキーで始まります。
コントロールが無効かどうかを判定する値を取得または設定します。
無効化されたコントロールは、マウスイベントやキーボードイベントを取得できません。
マウスの動作を示す値を取得または設定します。
デフォルトはSelectToolです。その場合は、マウスでクリックしてドラッグすると、テキストが選択されます。
コンテンツを一連の固定サイズのページとして表すかどうかを示す値を取得または設定します。
デフォルト値はnullです。その場合、FlexReportではページ区切り付きモードが使用され、SSRSレポートではページ区切りなしモードが使用されます。
レポートの実行に使用するパラメータを記述する{name: value}ペアの辞書を取得または設定します。
このプロパティは、レポートで特定のパラメータ（たとえば、非表示のパラメータ）を初期段階で渡す必要がある場合に役に立ちます。
reportViewer.parameters = {
'CustomerID': 'ALFKI'
};
レポート名を取得または設定します。
FlexReportの場合は、FlexReport定義ファイルに定義されたレポート名でこれを設定します。 SSRSレポートの場合は、これを空の文字列のままにしてください。SSRSレポートのパスは、filePath プロパティで指定します。
データを送信または要求するときに使用する要求ヘッダーを含むオブジェクトを取得または設定します。
このプロパティは、認証が必要なシナリオでよく使用されます。例:
viewer.requestHeaders = {
Authorization: 'Bearer ' + appAuthService.getToken();
};
C1 Web APIサービスのアドレスを取得または設定します。
例："http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report"。
コントロールに関連付けられた**tabindex**属性の値を取得または設定します。
**tabindex**属性値は、コントロールのホストHTML要素で指定することにより、Wijmoコントロールに対して静的に定義できます。 ただし、Wijmoコントロールは複雑な構造であり、コントロールが正しく機能するには、この属性値を内部要素に伝達する必要がある場合があるため、この値をアプリケーションのライフサイクルの後半で変更することはできません。
そのため、コントロールの**tabindex**を動的に読み取ったり変更したりするには、このプロパティを使用して行う必要があります。
モバイルテンプレートとPCテンプレートの切り替えに使用するしきい値を取得または設定します。
デフォルト値は767pxです。コントロールの幅がthresholdWidthより小さい場合は、 モバイルテンプレートが適用されます。コントロールの幅がthresholdWidth以上の場合は、PCテンプレートが適用されます。 thresholdWidthを0に設定すると、PCテンプレートだけが適用されます。 9999などの大きな数字に設定すると、モバイルテンプレートだけが適用されます。
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
このControl が所有する要素にイベントリスナーを追加します。
コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、コントロールが破棄されているときにそれらを簡単に削除すること ができます（dispose と removeEventListener メソッドを参照してください）。
イベントリスナーを削除しないと、メモリリークが発生する可能があります。
デフォルトでは passive パラメータはfalseに設定されています。これはイベントハンドラが event.preventDefault() を呼び出すことを意味します。タッチイベントまたはマウスホイールイベントにpassiveハンドラを追加する場合は、このパラメータをtrueに設定するとアプリケーションのパフォーマンスが向上します。
passive イベントリスナーの詳細については、「<a target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Improving_scrolling_performance_with_passive_listeners">Improving scrolling performance with passive listeners</a>」を参考してください。
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。
このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出される必要があります。テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。
以下のサンプルコードは、InputNumber コントロールのインスタンスにテンプレートを適用します。 このテンプレートには、'wj-part'属性が'input'、'btn-inc'、および'btn-dec'に設定された要素を含める必要があります。 コントロールのメンバである'_tbx'、'_btnUp'、'_btnDn'には、これらの要素への参照が割り当てられます。
```typescript this.applyTemplate('wj-control wj-inputnumber', templateString, { _tbx: 'input', _btnUp: 'btn-inc', _btnDn: 'btn-dec' }, 'input'); ``````
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
deferUpdate(fn: Function): void
beginUpdate/endUpdateブロック内で関数を実行します。
この関数の実行が完了するまでコントロールは更新されません。 このメソッドは、関数が例外を生成した場合でもendUpdate が呼び出されるようにします。
Function to be executed.
dispose(): void
ホスト要素との関連付けを解除することによってコントロールを破棄します。
dispose メソッドは、addEventListener メソッドによって追加されたイベントリスナーを自動的に削除します。
コントロールを動的に作成および削除するアプリケーションでは、dispose メソッドを呼び出すことが重要です。コントロールを破棄しないと、メモリリークが発生する可能があります。
disposeAll(e?: HTMLElement): void
HTML要素に含まれるすべてのWijmoコントロールを破棄します。
Container element.
getControl(element: any): Control
指定したDOM要素でホストされているコントロールを取得します。
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
getReportNames(serviceUrl: string, reportFilePath: string, httpHandler?: IHttpRequestHandler): IPromise
指定されたFlexReport定義ファイルに定義されたレポート名を取得します。
The address of C1 Web API service.
The full path to the FlexReport definition file.
The HTTP request handler. This parameter is optional.
getReports(serviceUrl: string, path: string, data?: any, httpHandler?: IHttpRequestHandler): IPromise
指定されたフォルダパス内のカタログ項目を取得します。
次のデータパラメータを渡すことで、フォルダパスの下のすべての項目を取得できます。 1) true値。 2) true値を含む"recursive"プロパティを持つオブジェクト。
The address of C1 Web API service.
The folder path. The path to the FlexReport definition file will be treated as a folder path.
The request data sent to the report service, or a boolean value indicates whether getting all items under the path.
The HTTP request handler. This parameter is optional.
getTemplate(): string
initialize(options: any): void
指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。
このメソッドを使用すると、各プロパティの値をコードで設定する代わりにプレーンなデータオブジェクトを使用してコントロールを初期化できます。
例:
```typescript 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; // など ```
初期化データは適用時に型チェックされます。初期化オブジェクトに不明なプロパティ名または無効なデータ型が含まれている場合、このメソッドは例外をスローします。
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
非同期更新を発生させるため、コントロールを無効にします。
Whether to update the control layout as well as the content.
invalidateAll(e?: HTMLElement): void
指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。
このメソッドは、コントロールの表示状態やサイズを変更する動的なパネルをアプリケーションで使用している場合に使用します。たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、それらのコントロールが適切に機能しなくなる可能性があります。
これが起こる場合は、動的コンテナーで適切なイベントを処理し、invalidateAllメソッドを呼び出してコンテナー内のWijmoコントロールのレイアウト情報が適切に更新されるようにする必要があります。
Container element. If set to null, all Wijmo controls on the page will be invalidated.
moveToPage(index: number): IPromise
指定したインデックスにあるページに移動します。
Index (0-base) of the page to move to.
onBeforeSendRequest(e: RequestEventArgs): void
beforeSendRequest イベントを発生させます。
The RequestEventArgs object.
onFullScreenChanged(e?: EventArgs): void
fullScreenChanged イベントを発生させます。
onGotFocus(e?: EventArgs): void
gotFocus イベントを発生させます。
onInvalidInput(e: CancelEventArgs): void
invalidInput イベントを発生させます。
イベントハンドラがイベントをキャンセルした場合、コントロールは無効な入力とフォーカスを保持します。
onLostFocus(e?: EventArgs): void
lostFocus イベントを発生させます。
onMouseModeChanged(e?: EventArgs): void
mouseModeChanged イベントを発生させます。
onPageIndexChanged(e?: EventArgs): void
pageIndexChanged イベントを発生させます。
onPageLoaded(e: PageLoadedEventArgs): void
pageLoadedイベントを発生させます。
The PageLoadedEventArgs object.
onQueryLoadingData(e: QueryLoadingDataEventArgs): void
queryLoadingDataイベントを発生させます。
The QueryLoadingDataEventArgs object that contains the loading data.
onRefreshed(e?: EventArgs): void
refreshedイベントを発生させます。
onRefreshing(e?: EventArgs): void
refreshingイベントを発生させます。
onViewModeChanged(oldValue: ViewMode, newValue: ViewMode): void
viewModeChanged イベントを発生させます。
onZoomFactorChanged(e?: EventArgs): void
zoomFactorChanged イベントを発生させます。
onZoomModeChanged(e?: EventArgs): void
zoomModeChanged イベントを発生させます。
refresh(fullUpdate?: boolean): void
コントロールを更新します。
Whether to update the control layout as well as the content.
refreshAll(e?: HTMLElement): void
HTML要素で存在するすべてのWijmoコントロールを更新する。
コントロールが時間おいて更新される代わりに直ちに更新されること以外はinvalidateAll メソッドと同様です。
Container element. If set to null, all Wijmo controls on the page will be invalidated.
reload(): void
ドキュメントを再ロードします。
これは、ドキュメントを強制的に再ロードおよび再レンダリングする場合に便利です。
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
各要求がサーバーに送信される前に発生します。
このイベントでは、サーバーに送信する前に、URL、ヘッダー、データなどのリクエストオプションに加えてリクエストメソッドも変更できます。 このイベントは、RequestEventArgs 型の引数を渡します。 そのプロパティは、httpRequest メソッドのパラメータと同じ意味と構造を持ち、要求属性を更新するように変更できます。
たとえば、認証トークンを 'Authorization'ヘッダーに入れることができます。
viewer.beforeSendRequest.addHandler((s, e) => {
e.settings.requestHeaders.Authorization = 'Bearer ' + appAuthService.getToken();
});
ブラウザで自動的に（たとえば、URLがwindow.open() 関数へのパラメータとして、 またはHTMLリンクとして使用される場合）実行されるHTTP要求が誘導するためにURLが使用されている場合、 e.settings引数はnullになります。
無効な入力値が検出された場合に発生します。
ユーザーが適切な型に変換できない値、または有効な範囲外の値を入力または貼り付けると、無効な入力が発生する可能性があります。
イベントハンドラがイベントをキャンセルした場合、コントロールは無効なコンテンツとフォーカスを保持するため、ユーザーはエラーを修正できます。
イベントがキャンセルされない場合、コントロールは無効な入力を無視し、元のコンテンツを保持します。
ドキュメントのロード前に、サービスに送られる要求データをクエリーしたときに発生します。
FlexReportまたはSSRSレポートを表示するReportViewerコントロールを定義します。
serviceUrl プロパティは、レポートサービスを提供するC1 Web APIのURLを示します。 レポートサービスは、C1FlexReportを使用してFlexReportを処理し、C1SSRSDocumentSourceとC1PdfDocumentSourceを使用してSSRSレポートを処
次に、FlexReportを表示する方法のサンプルを示します。 ```typescript 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レポートを表示する方法のサンプルを示します。 ```typescript 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'; ```