V2J
ActiveReportsJS API Module ReportViewer ActiveReportsJS API モジュール

ReportViewer モジュール

型の別名

DocumentLoadEventArgs

DocumentLoadEventArgs: { cancelled?: undefined | false | true; pageCount: number }

「documentLoaded」イベントの引数を定義します。

型宣言

  • オプション Readonly cancelled?: undefined | false | true

    文書の描画がキャンセルされた場合は、「true」です。

  • Readonly pageCount: number

    文書のページ数。

ExportSettings

ExportSettings: Record<string, string | boolean | number | null>

エクスポートパネルの初期設定:

var exportSettings = {
    filename: 'NewFile'
};

LoadResult

LoadResult: { document: IDocument; status: "loaded" } | { details?: undefined | string; message: string; status: "error" } | { status: "cancelled" }

PanelsLocation

PanelsLocation: "sidebar" | "toolbar"

ビューワパネルの場所。

ParameterPanelsLocation

ParameterPanelsLocation: PanelLocation

パラメータビュー/パネルの位置。

ReportLoadEventArgs

ReportLoadEventArgs: { report: PageReport }

「reportLoaded」イベントの引数。

型宣言

  • Readonly report: PageReport

    ロードされたレポート。

SearchOptions

SearchOptions: { matchCase?: undefined | false | true; searchBackward?: undefined | false | true; startPage?: undefined | number; text: string; wholeWord?: undefined | false | true }

ReportViewer.searchメソッドの引数タイプを定義します。

型宣言

  • オプション matchCase?: undefined | false | true

    大文字と小文字を区別する検索。

  • オプション searchBackward?: undefined | false | true

    現在の位置から逆方向に検索します。

  • オプション startPage?: undefined | number

    検索を開始するページ。

  • text: string

    検索するテキスト。

  • オプション wholeWord?: undefined | false | true

    単語単位で検索します。

ToolbarItem

ToolbarItem: { action?: undefined | ((curr?: ToolbarItem): Partial<ToolbarItem> | void ); checked?: undefined | false | true; enabled?: undefined | false | true; icon?: Icon; iconCssClass?: undefined | string; key: string; onUpdate?: undefined | ((args: ChangedEventArgs, curr: ToolbarItem): Partial<ToolbarItem> | void ); text?: undefined | string; title?: undefined | string }

ツールバーのアイテムの設定と動作を定義します。

型宣言

  • オプション action?: undefined | ((curr?: ToolbarItem): Partial<ToolbarItem> | void )
  • オプション checked?: undefined | false | true
  • オプション enabled?: undefined | false | true
  • オプション icon?: Icon
  • オプション iconCssClass?: undefined | string
    deprecated

    use icon instead

  • key: string
  • オプション onUpdate?: undefined | ((args: ChangedEventArgs, curr: ToolbarItem): Partial<ToolbarItem> | void )
  • オプション text?: undefined | string
  • オプション title?: undefined | string

ToolbarLayout

ToolbarLayout: { default?: string[]; fullscreen?: string[]; mobile?: string[] }

さまざまなビューモードでツールバーのアイテムのレイアウト(順序と表示設定)を説明します。

型宣言

  • オプション default?: string[]

    デフォルト(デスクトップ)のビューモード。 他のモードが指定されていない場合にも適用されます。

  • オプション fullscreen?: string[]

    フルスクリーンモードのレイアウト。

  • オプション mobile?: string[]

    モバイルデバイスのツールバーレイアウト。

UnregisterHandler

UnregisterHandler: (): any

イベントハンドラを登録解除します。

型宣言

    • (): any
    • 戻り値 any

ViewerMouseMode

ViewerMouseMode: "Pan" | "Selection"

ビューワのマウスモード。

ViewerRenderMode

ViewerRenderMode: "Galley" | "Paginated"

ビューワの描画モード。

ViewerViewMode

ViewerViewMode: "Continuous" | "SinglePage"

ビューワの表示モード。

ViewerZoomMode

ViewerZoomMode: "FitToWidth" | "FitPage" | number

ビューワのズームモード。