[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

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

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

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

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

    引数

    • element: any

      コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。

    • オプション options: any

      コントロールの初期化データを含むJavaScriptオブジェクト。

    戻り値 ReportViewer

プロパティ

filePath

filePath: string

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

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

fullScreen

fullScreen: 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();
};

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

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

メソッド

moveToPage

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

    引数

    • index: number

      移動先のページの0から始まるインデックス。

    戻り値 IPromise

    An wijmo.viewer.IPromise object with current page index.

onBeforeSendRequest

onFullScreenChanged

onMouseModeChanged

onPageIndexChanged

onSelectMouseModeChanged

  • onSelectMouseModeChanged(e?: EventArgs): void

onViewModeChanged

onZoomFactorChanged

reload

  • reload(): void

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

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

    戻り値 void

showPageSetupDialog

  • showPageSetupDialog(): void

zoomToView

  • zoomToView(): void

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

    戻り値 void

zoomToViewWidth

  • zoomToViewWidth(): void

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

    戻り値 void

静的 getReportNames

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

    引数

    • serviceUrl: string

      C1 Web APIサービスのアドレス。

    • reportFilePath: string

      FlexReport定義ファイルの完全パス。

    • オプション httpHandler: IHttpRequestHandler

      HTTPリクエストハンドラ。 このパラメータはオプションです。

    戻り値 IPromise

    An wijmo.viewer.IPromise object with a string array which contains the report names.

静的 getReports

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

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

    引数

    • serviceUrl: string

      C1 Web APIサービスのアドレス。

    • path: string

      フォルダパス。 FlexReport定義ファイルのパスは、フォルダパスとして扱われます。

    • オプション data: any

      レポートサービスに送られる要求データ、またはパス下のすべての項目を取得するかどうかを示すboolean値。

    • オプション httpHandler: IHttpRequestHandler

      HTTPリクエストハンドラ。 このパラメータはオプションです。

    戻り値 IPromise

    An IPromise object with an array of wijmo.viewer.ICatalogItem.

イベント

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

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

mouseModeChanged

mouseModeChanged: Event

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

pageIndexChanged

pageIndexChanged: Event

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

queryLoadingData

queryLoadingData: Event

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

selectMouseModeChanged

selectMouseModeChanged: Event

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

viewModeChanged

viewModeChanged: Event

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

zoomFactorChanged

zoomFactorChanged: Event

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