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

Core

Namespace: Core

Table of contents

クラス

インターフェイス

型の別名

変数

メソッド

Type aliases

Environment

Ƭ Environment: Object

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

Type declaration

Name Type Description
ReportFolder? string レポートのディレクトリ名。
ReportName? string レポート名。

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1576

NoValueType

Ƭ NoValueType: typeof noValue

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1420

Parameter

Ƭ Parameter: Object

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

Type declaration

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1654

ParameterDataType

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

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1414

ParameterDescriptor

Ƭ ParameterDescriptor: Object

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

Type declaration

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1440

ParameterDescriptorConfig

Ƭ ParameterDescriptorConfig: Object

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

Type declaration

Name Type Description
dateOnly boolean 日付を指定します。 DateTimeパラメーターの場合に使用します。
hidden boolean パラメータが非表示であることを示します。非表示のパラメータはパラメータパネルに表示されません。
multiline boolean 複数の値を許可します。
prompt string パラメータのダイアログの表示文字列。

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1643

ParameterDescriptorEx

Ƭ ParameterDescriptorEx: ParameterDescriptor & ParameterDescriptorConfig

パラメータ記述子。

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1639

ParameterValue

Ƭ ParameterValue: Object

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

Type declaration

Name Type Description
fields? any[] 拡張されたパラメータビューの追加フィールド。
label string 表示するラベル。
value ParameterVariant Value

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1431

ParameterVariant

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

パラメータ値の型。

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1427

RDLReportDefinition

Ƭ RDLReportDefinition: PartialTyped<WithStringExpr<Report>>

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1140

RenderOptions

Ƭ RenderOptions: Object

文書の描画オプション。

Type declaration

Name Type Description
galleyMode boolean 改ページなしですべてのデータを描画します。
interactivityActions ({ Data: string ; Type: "toggle" } | { Data: string ; Type: "sort" })[] Holds sorts/toggles state of the document.

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1493

ReportParameters

Ƭ ReportParameters: Object

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

Index signature

▪ [name: string]: Parameter

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1667

ResourceLocator

Ƭ ResourceLocator: Object

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

Type declaration

Name Type
fork (reportName: string) => ResourceLocator
getResource <T>(uri: string) => Promise<null | T>
getResourceUri (resourceID: string) => string

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1396

SelectAllType

Ƭ SelectAllType: Object

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1422

ValidationResult

Ƭ ValidationResult: Object

パラメータの検証結果。

Type declaration

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1623

ValidationResults

Ƭ ValidationResults: Object

パラメータの検証結果。

Index signature

▪ [parameter: string]: ValidationResult

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1618

Variables

FontStore

• FontStore: Object

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

Type declaration

Name Type
registerFonts (...fonts: FontDescriptor[]) => Promise<void> & (configUri: string) => Promise<void>
getFonts () => FontDescriptor[]

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1809

noValue

• noValue: undefined

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1418

selectAll

• selectAll: SelectAllType

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

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1416

Functions

registerFont

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

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

Parameters

Name Type Description
...fonts FontDescriptor[] 登録されるフォント記述子のセット。

Returns

Promise<void>

Promise that will be resolved when all fonts are loaded and ready for render

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1805

setLicenseKey

▸ setLicenseKey(key): void

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

Parameters

Name Type Description
key string ライセンスキーの値。

Returns

void

Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1760