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

Core

Namespace: Core

Table of contents

クラス

インターフェイス

型の別名

変数

メソッド

Type aliases

Environment

Ƭ Environment: Object

Report environment used for expressions calculation.

Type declaration

Name Type Description
ReportFolder? string Report directory name
ReportName? string Report name

Defined in

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

NoValueType

Ƭ NoValueType: typeof noValue

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

Defined in

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

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:1763

ParameterDataType

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

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

Defined in

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

ParameterDescriptor

Ƭ ParameterDescriptor: Object

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

Type declaration

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

Defined in

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

ParameterDescriptorConfig

Ƭ ParameterDescriptorConfig: Object

Parameter visual presentation settings.

Type declaration

Name Type Description
dateOnly boolean Date only. For DateTime parameters.
hidden boolean Indicates that parameter is hidden. Hidden parameters are not visible in parameter panel.
multiline boolean Multiline.
prompt string Parameter value prompt.

Defined in

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

ParameterDescriptorEx

Ƭ ParameterDescriptorEx: ParameterDescriptor & ParameterDescriptorConfig

パラメータ記述子。.

Defined in

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

ParameterValue

Ƭ ParameterValue: Object

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

Type declaration

Name Type Description
fields? any[] Additional fields for extended parameter view
label string 表示するラベル。
value ParameterVariant Value

Defined in

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

ParameterVariant

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

パラメータ値の型。

Defined in

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

RDLReportDefinition

Ƭ RDLReportDefinition: PartialTyped<RDLReport>

Defined in

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

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:1602

ReportParameters

Ƭ ReportParameters: Object

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

Index signature

▪ [name: string]: Parameter

Defined in

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

ResourceLocator

Ƭ ResourceLocator: Object

Provide tools for accessing external resources by URIs.

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:1505

SelectAllType

Ƭ SelectAllType: Object

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

Defined in

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

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:1732

ValidationResults

Ƭ ValidationResults: Object

パラメータの検証結果。

Index signature

▪ [parameter: string]: ValidationResult

Dictionary with validation results per parameter

Defined in

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

Variables

FontStore

• FontStore: Object

Provides tools for registering fonts in CSS and pdf export.

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:1918

noValue

• noValue: undefined

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

Defined in

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

selectAll

• selectAll: SelectAllType

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

Defined in

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

Functions

registerFont

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

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

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:1914

setLicenseKey

▸ setLicenseKey(key): void

Set ActiveReportsJSのライセンスキー。

Parameters

Name Type Description
key string license key value

Returns

void

Defined in

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