Class: PageReport

Core.PageReport

PageReport クラス。

Table of contents

コンストラクタ

• constructor

アクセサー

• name
• parameters
• resourceLocator
• LicenseKey

メソッド

• load
• run
• validateParameters

Constructors

constructor

• new PageReport(options?)

Create new instance of PageReport class.

Parameters

Name	Type	Description
options?	Partial<{ i18n: i18n ; language: string }>	pageReport options - language: report language. Default language is 'en'.

Defined in

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

Accessors

name

• get name(): string

レポート名を取得します。

Returns

string

Defined in

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

---

parameters

• get parameters(): ReportParameters

レポートパラメータのコレクションを取得します。

Returns

ReportParameters

Defined in

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

---

resourceLocator

• get resourceLocator(): ResourceLocator

リソースロケーターのインスタンスを取得します。

Returns

ResourceLocator

Defined in

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

---

LicenseKey

• Static get LicenseKey(): string

deprecated Use setLicenseKey method instead.

Returns

string

Defined in

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

• Static set LicenseKey(value): void

deprecated Use setLicenseKey method instead.

Parameters

Name	Type
value	string

Returns

void

Defined in

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

Methods

load

▸ load(report, options?): Promise<void>

レポートテンプレートをロードします。

Parameters

Name	Type	Description
report	string | { Name: string ; Type: "report" } & { Author: undefined | string ; Body: undefined | null | { Name: string ; Type: "section" } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string | undefined; DataElementName?: string | undefined; DataElementStyle?: DataElementStyle | undefined; ... 17 more ...; Value?: RDLExpr<...> | undefined; }) | ... 20 more ... | ( & ))[] | undefined; Style?: ( & ) | undefin... ; ConsumeContainerWhitespace: undefined | boolean ; CustomProperties: undefined | { Name: string } & { Value?: RDLExpr<Variant> | undefined; }[] ; DataElementName: undefined | string ; DataElementStyle: undefined | "Attribute" | "Element" ; DataSets: undefined | { Name: string } & { Filters?: ( & { FilterExpression?: RDLExpr<Variant> | undefined; Operator?: FilterOperator | undefined; FilterValues?: RDLExpr<Variant>[] | undefined; })[] | undefined; ... 6 more ...; WidthSensitivity?: ThreeStateBool | undefined; }[] ; DataSources: undefined | { Name: string } & { Transaction?: boolean | undefined; DataSourceReference?: string | undefined; ConnectionProperties?: ( & { Prompt?: string | undefined; DataProvider?: string | undefined; ConnectString?: string | undefined; IntegratedSecurity?: boolean | undefined; }) | undefined; }[] ; Description: undefined | string ; DocumentMap: undefined | & { Levels?: string[] | undefined; Source?: "None" | "Labels" | "Headings" | "All" | undefined; NumberingStyle?: string | undefined; } ; EmbeddedImages: undefined | { Name: string } & { MIMEType?: string | undefined; ImageData?: string | undefined; }[] ; FixedPage: undefined | null | { Name: string ; Type: "fixedpage" } & { DataElementName?: string | undefined; Pages?: ({ Type: "fixedpagesection"; } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string | undefined; DataElementName?: string | undefined; ... 18 more ...; Value?: RDLExpr<...> | undefined; }) | ... 20 more ... | ( & ))[] | undefined; S... ; Language: undefined | string ; Layers: undefined | { Name: string ; Type: "layer" } & { DesignerLock?: boolean | undefined; DesignerTransparency?: number | undefined; DesignerVisible?: boolean | undefined; TargetDevice?: string | undefined; }[] ; LocalizationResources: undefined | & { Language?: string | undefined; Data?: ({ Name: string; } & { Value?: RDLExpr<Variant> | undefined; })[] | undefined; }[] ; Page: undefined | & { BottomMargin?: string | undefined; Columns?: number | undefined; ColumnSpacing?: string | undefined; LeftMargin?: string | undefined; PageHeight?: string | undefined; PageWidth?: string | undefined; RightMargin?: string | undefined; TopMargin?: string | undefined; } ; PageFooter: undefined | null | { Name: string ; Type: "pagesection" } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string | undefined; DataElementName?: string | undefined; DataElementStyle?: DataElementStyle | undefined; ... 17 more ...; Value?: RDLExpr<...> | undefined; }) | ... 20 more ... | ( & ))[] | undefined; Style?: ( & ) | undefin... ; PageHeader: undefined | null | { Name: string ; Type: "pagesection" } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string | undefined; DataElementName?: string | undefined; DataElementStyle?: DataElementStyle | undefined; ... 17 more ...; Value?: RDLExpr<...> | undefined; }) | ... 20 more ... | ( & ))[] | undefined; Style?: ( & ) | undefin... ; ReportParameters: undefined | { Name: string } & { Multiline?: boolean | undefined; AllowBlank?: boolean | undefined; DataType?: ReportParameterType | undefined; DateOnly?: boolean | undefined; DefaultValue?: ( & ) | ... 1 more ... | undefined; ... 6 more ...; ValidValues?: ( & ) | ... 1 more ... | undefined; }[] ; StartPageNumber: undefined | number ; ThemeUri: undefined | string ; Width: undefined | string }	URI、レポートテンプレートまたはテンプレートオブジェクト。
options?	Object	実行時間の設定。
options.environment?	Environment	-
options.resourceLocator?	Partial<ResourceLocator>	-

Returns

Promise<void>

Defined in

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

---

run

▸ run(): Promise<PageDocument>

レポート処理を開始します。

Returns

Promise<PageDocument>

Defined in

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

---

validateParameters

▸ validateParameters(): ValidationResults

Validates the parameter values.

Returns

ValidationResults

Validation result.

Defined in

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