V2.2J
ActiveReportsJS API Module Core ActiveReportsJS API モジュール

Core モジュール

型の別名

変数

モジュール

クラス

インターフェイス

メソッド

型の別名

Environment

Environment: { ReportFolder?: undefined | string; ReportName?: undefined | string }

式の計算に使用されるレポート環境。

型宣言

  • オプション Readonly ReportFolder?: undefined | string

    レポートのディレクトリ名。

  • オプション Readonly ReportName?: undefined | string

    レポート名。

NoValueType

NoValueType: typeof noValue

値が設定されていないことを示す特別な値を定義します。

Parameter

Parameter: { descriptor: ParameterDescriptorEx; errorMessage: string; isValidValuesLoaded: boolean; validValues: ParameterValue[]; values: ParameterVariant[] }

レポートのパラメータを定義します。

型宣言

  • descriptor: ParameterDescriptorEx

    パラメータ記述子。

  • errorMessage: string

    無効なパラメータの値に対してエラーメッセージを表示します。

  • isValidValuesLoaded: boolean

    有効な値のリストがロードされた場合、「true」です。

  • validValues: ParameterValue[]

    有効な値。

  • values: ParameterVariant[]

    パラメータ値。

ParameterDataType

ParameterDataType: "Boolean" | "String" | "Integer" | "Float" | "Date" | "DateTime"

パラメータのデータ型を定義します。

ParameterDescriptor

ParameterDescriptor: { allowBlank: boolean; dataType: ParameterDataType; dependsOn: string[]; multiValue: boolean; name: string; nullable: boolean; selectAllValue?: any }

レポートのパラメータ記述子を定義します。

型宣言

  • allowBlank: boolean

    空白を許可します。

  • dataType: ParameterDataType

    パラメータのデータ型。

  • dependsOn: string[]

    パラメータが依存するパラメータ。

  • multiValue: boolean

    パラメータは複数値です。

  • name: string

    パラメータ名。

  • nullable: boolean

    null を許可します。

  • オプション selectAllValue?: any

    すべての使用可能な値が選択されていることを示す複数値パラメータの特殊な値。

ParameterDescriptorConfig

ParameterDescriptorConfig: { hidden: boolean; multiline: boolean; prompt: string }

パラメータの視覚的な表現の設定。

型宣言

  • hidden: boolean

    パラメータが非表示であることを示します。非表示のパラメータはパラメータパネルに表示されません。

  • multiline: boolean

    複数の値を許可します。

  • prompt: string

    パラメータのダイアログの表示文字列。

ParameterDescriptorEx

ParameterDescriptorEx: ParameterDescriptor & ParameterDescriptorConfig

パラメータ記述子。

ParameterValue

ParameterValue: { fields?: any[]; label: string; value: ParameterVariant }

パラメータ値を定義します。

型宣言

  • オプション fields?: any[]

    拡張されたパラメータビューの追加フィールド。

  • label: string

    表示するラベル。

  • value: ParameterVariant

    値。

ParameterVariant

ParameterVariant: string | number | boolean | Date | null | NoValueType | SelectAllType

パラメータ値の型。

RDLReportDefinition

RDLReportDefinition: Report

RenderOptions

RenderOptions: { galleyMode: boolean; interactivityActions: Array<{ Data: string; Type: "toggle" } | { Data: string; Type: "sort" }> }

文書の描画オプション。

型宣言

  • galleyMode: boolean

    改ページなしですべてのデータを描画します。

  • interactivityActions: Array<{ Data: string; Type: "toggle" } | { Data: string; Type: "sort" }>

    文書のソートと切り替え状態。

ReportParameters

ReportParameters: {}

レポートのパラメータを定義します。

型宣言

ResourceLocator

ResourceLocator: { getResource: <T>(uri: string): Promise<T | null> ; getResourceUri: (resourceID: string): string ; fork: any }

URIを使用して外部リソースをアクセスするツールを提供します。

型宣言

  • getResource: <T>(uri: string): Promise<T | null>

    リソースコンテンツを返します。

      • <T>(uri: string): Promise<T | null>

      • Type parameters

        • T

        引数

        • uri: string

        戻り値 Promise < T | null >

  • getResourceUri: (resourceID: string): string

    相対IDとベースパスに基づいて絶対リソースURIを返します。

      • (resourceID: string): string

      • 引数

        • resourceID: string

        戻り値 string

  • fork: function

    • 現在のベースパスに基づいて新しいResourceLocatorインスタンスを作成します。

      引数

      • reportName: string

        新しいレポートの相対パス。

      戻り値 ResourceLocator

SelectAllType

SelectAllType: {}

すべての値が設定されていることを示す複数値パラメータの特別な値を定義します。

型宣言

ValidationResult

ValidationResult: { isValid: boolean; message?: undefined | string; value?: any }

パラメータの検証結果。

型宣言

  • isValid: boolean

    検証が成功したかどうかを示します。

  • オプション message?: undefined | string

    検証が失敗したときに表示されるエラーメッセージのテキスト。

  • オプション value?: any

    検証した後のパラメータ値。

ValidationResults

ValidationResults: {}

パラメータの検証結果。

型宣言

  • [parameter: string]: ValidationResult

    パラメータごとの検証結果を含む辞書。

変数

定数 FontStore

FontStore: { getFonts: (): FontDescriptor[] ; registerFonts: (...fonts: FontDescriptor[]): Promise<void> & (configUri: string): Promise<void> }

CSSおよびPDFのエクスポートでフォントを登録するためのツールを提供します。

型宣言

  • getFonts: (): FontDescriptor[]

    登録されたフォント記述子を取得します。

    returns

    登録されたフォント記述子のリスト。

  • registerFonts: (...fonts: FontDescriptor[]): Promise<void> & (configUri: string): Promise<void>
    param

    fontsConfig.jsonファイルへのパス。 指定されたフォントをconfigファイルに登録します。

    FontStore.registerFonts('./fontsConfig.json');
    param

    fontsConfig.jsonファイルへのパス。 指定されたフォントをconfigファイルに登録します。

    FontStore.registerFonts('./fontsConfig.json');
    returns

    Promise

定数 noValue

noValue: undefined

値が設定されていないことを示す特別な値。

定数 selectAll

selectAll: SelectAllType

すべての値が設定されていることを示す複数値パラメータの特別な値。

メソッド

registerFont

  • 非推奨

    FontStore.registerFontsを使用します。 ユーザー指定のフォントを登録してロードします。

    引数

    • Rest ...fonts: FontDescriptor[]

      登録されるフォント記述子のセット。

    戻り値 Promise < void >

    すべてのフォントが読み込まれ、描画の準備ができたときに解決します。

setLicenseKey

  • setLicenseKey(key: string): void

  • ActiveReportsJSのライセンスキーを設定します。

    引数

    • key: string

      ライセンスキーの値。

    戻り値 void