[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Core

名前空間: Core

Table of contents

名前空間

クラス

インターフェイス

型の別名

変数

関数

型の別名

Environment

Ƭ Environment: Object

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

型宣言

名前 型 説明
ReportFolder? string レポートのディレクトリ名。
ReportName? string レポート名。

EventHandler

Ƭ EventHandler<TArgs>: (args: TArgs) => void

Type parameters

名前 説明
TArgs イベント引数の型。

型宣言

▸ (args): void

Event Handler

パラメータ
名前 型
args TArgs
Returns

void

NoValueType

Ƭ NoValueType: typeof noValue

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

Parameter

Ƭ Parameter: Object

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

型宣言

名前 型 説明
descriptor ParameterDescriptorEx パラメータ記述子。
errorMessage string | null 無効なパラメータの値に対してエラーメッセージを表示します。
isValidValuesLoaded boolean 有効な値のリストがロードされた場合、「true」です。
validValues ParameterValue[] 有効な値。
values ParameterVariant[] パラメータ値。

ParameterDataType

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

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

ParameterDescriptor

Ƭ ParameterDescriptor: Object

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

型宣言

名前 型 説明
allowBlank boolean 空白を許可します。
dataType ParameterDataType パラメータのデータ型。
dependsOn string[] パラメータが依存するパラメータ。
displayFormat string 値を表示する形式。
multiValue boolean パラメータは複数値です。
name string パラメータ名。
nullable boolean null を許可します。
selectAllValue? any すべての使用可能な値が選択されていることを示す複数値パラメータの特殊な値。

ParameterDescriptorConfig

Ƭ ParameterDescriptorConfig: Object

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

型宣言

名前 型 説明
hidden boolean パラメータが非表示であることを示します。非表示のパラメータはパラメータパネルに表示されません。
multiline boolean 複数の値を許可します。
prompt string パラメータのダイアログの表示文字列。

ParameterDescriptorEx

Ƭ ParameterDescriptorEx: ParameterDescriptor & ParameterDescriptorConfig

パラメータ記述子。

ParameterValue

Ƭ ParameterValue: Object

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

型宣言

名前 型 説明
fields? any[] 拡張されたパラメータビューの追加フィールド。
label string 表示するラベル。
value ParameterVariant 値。

ParameterVariant

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

パラメータ値の型。

RenderOptions

Ƭ RenderOptions: Object

文書の描画オプション。

型宣言

名前 型 説明
galleyMode boolean 改ページなしですべてのデータを描画します。
interactivityActions ({ Data: string ; Type: "toggle" } | { Data: string ; Type: "sort" })[] ドキュメントのソート/トグル状態を保持します。

ReportParameters

Ƭ ReportParameters: Object

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

型宣言

名前 型
applySteps (steps: ApplyParameterStep[]) => Promise<void>
getDescriptors () => { [name: string]: ParameterDescriptorEx; }
getValues () => { [name: string]: ParameterState; }
getValuesFor (knownValues: { [name: string]: ParameterVariant | ParameterVariant[]; }, requiredParameters: { [name: string]: { fields: string[] } | null; }) => Promise<GetValuesResult>
validate () => ValidationResults

ResourceLocator

Ƭ ResourceLocator: Object

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

型宣言

名前 型
fork (reportName: string) => ResourceLocator
getResource <T>(uri: string) => Promise<null | T>
getResourceUri (resourceID: string) => string

SelectAllType

Ƭ SelectAllType: Object

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

UnregisterHandler

Ƭ UnregisterHandler: () => void

型宣言

▸ (): void

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

Returns

void

ValidationResult

Ƭ ValidationResult: Object

パラメータの検証結果。

型宣言

名前 型 説明
isValid boolean 検証が成功したかどうかを示します。
message? string 検証が失敗したときに表示されるエラーメッセージのテキスト。
value? any 検証した後のパラメータ値。

ValidationResults

Ƭ ValidationResults: Object

パラメータの検証結果。

Index signature

▪ [parameter: string]: ValidationResult

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

Variables

CultureInfo

• CultureInfo: Object

言語および文化固有のテキスト書式のデータを提供します。

型宣言

名前 型
registerCulture (identifier: string, data: LocaleData) => void

CustomCode

• CustomCode: Object

ユーザー定義関数を登録するためのツールを提供します。

型宣言

名前 型
getFunctions () => UserDefinedFunction[]
registerFunctions (functions: UserDefinedFunction[]) => void

FontStore

• FontStore: Object

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

型宣言

名前 型
registerFonts (...fonts: FontDescriptor[]) => Promise<void> & (configUri: string) => Promise<void>
getFonts () => FontDescriptor[]

noValue

• noValue: undefined

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

selectAll

• selectAll: SelectAllType

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

関数

registerFont

▸ registerFont(...fonts): Promise<void>

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

パラメータ

名前 型 説明
...fonts FontDescriptor[] 登録されるフォント記述子のセット。

戻り値

Promise<void>

すべてのフォントがロードされ、レンダリングの準備ができたときに解決されるPromise。

setLicenseKey

▸ setLicenseKey(key): void

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

パラメータ

名前 型 説明
key string ライセンスキーの値。

戻り値

void