Core.PageReport
Class: PageReport
Core.PageReport
PageReport class
Table of contents
Constructors
Accessors
Methods
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:1787
Accessors
name
• get name(): string
Gets the report name.
Returns
string
Defined in
node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1792
parameters
• get parameters(): ReportParameters
Gets the report parameters collection.
Returns
Defined in
node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1794
resourceLocator
• get resourceLocator(): ResourceLocator
Gets the report resource locator instance.
Returns
Defined in
node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1796
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:1798
• 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:1799
Methods
load
▸ load(report, options?): Promise<void>
Loads the report template.
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; Language?: string | undefined; DataElementName?: string | undefined; DataElementStyle?: DataElementStyle | undefined; ... 17 more ...; Value?: RDLExpr<...> | undefined; }) | ... 19 more ... | ( & ))[] | undefined; St... ; ConsumeContainerWhitespace: undefined | boolean ; CustomProperties: undefined | { Name: string } & { Value?: RDLExpr<Variant> | undefined; }[] ; DataElementName: undefined | string ; DataElementStyle: undefined | ReportDataElementStyle ; DataSets: undefined | { Name: string } & { Filters?: ( & { FilterExpression?: RDLExpr<Variant> | undefined; Operator?: FilterOperator | undefined; FilterValues?: RDLExpr<Variant>[] | undefined; })[] | undefined; Fields?: ( & )[] | undefined; Query?: ( & ) | undefined; }[] ; DataSources: undefined | { Name: string } & { Transaction?: boolean | undefined; DataSourceReference?: string | undefined; ConnectionProperties?: ( & { DataProvider?: string | undefined; ConnectString?: string | undefined; ... 4 more ...; WidthSensivity?: "Auto" | ... 2 more ... | 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; Language?: string | undefined; ... 19 more ...; Value?: RDLExpr<...> | undefined; }) | ... 19 more ... | ( & ))[] | undefined; Style?: ... ; 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 | & { Style?: ( & { [x: string]: any; [x: number]: any; }) | undefined; PageHeight?: string | undefined; PageWidth?: string | undefined; LeftMargin?: string | undefined; RightMargin?: string | undefined; TopMargin?: string | undefined; BottomMargin?: string | undefined; Columns?: number | undefined; ColumnSpacing?: st... ; PageFooter: undefined | null | { Name: string ; Type: "pagesection" } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string | undefined; Language?: string | undefined; DataElementName?: string | undefined; DataElementStyle?: DataElementStyle | undefined; ... 17 more ...; Value?: RDLExpr<...> | undefined; }) | ... 19 more ... | ( & ))[] | undefined; St... ; PageHeader: undefined | null | { Name: string ; Type: "pagesection" } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string | undefined; Language?: string | undefined; DataElementName?: string | undefined; DataElementStyle?: DataElementStyle | undefined; ... 17 more ...; Value?: RDLExpr<...> | undefined; }) | ... 19 more ... | ( & ))[] | undefined; St... ; ReportParameters: undefined | { Name: string } & { Multiline?: boolean | undefined; DataType?: ReportParameterType | undefined; Nullable?: boolean | undefined; DefaultValue?: ( & { Values?: RDLExpr<Variant>[] | undefined; }) | ( & ) | undefined; ... 6 more ...; SelectAllValue?: RDLExpr<...> | undefined; }[] ; StartPageNumber: undefined | number ; ThemeUri: undefined | string ; Width: undefined | string } |
URI or the report template or template object. |
options? |
Object |
Execution time settings. |
options.environment? |
Environment |
- |
options.resourceLocator? |
Partial<ResourceLocator> |
- |
Returns
Promise<void>
Defined in
node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1807
run
▸ run(): Promise<PageDocument>
Starts rendering the report.
Returns
Promise<PageDocument>
Defined in
node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1825
validateParameters
▸ validateParameters(): ValidationResults
Validates the parameter values.
Returns
Validation result.
Defined in
node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:1814