[]
DEMO DOCS API
DOWNLOAD
(Showing Draft Content)

Core

Namespace: Core

Table of contents

Classes

Interfaces

Type aliases

Variables

Functions

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

Defines special value to indicate that value is not set.

Defined in

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

Parameter

Ƭ Parameter: Object

Defines report parameter

Type declaration

Name Type Description
descriptor ParameterDescriptorEx Parameter descriptor
errorMessage string Shows error message for invalid parameter values
isValidValuesLoaded boolean true if valid values list was loaded
validValues ParameterValue[] Valid values
values ParameterVariant[] Parameter values

Defined in

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

ParameterDataType

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

Defines parameter data type.

Defined in

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

ParameterDescriptor

Ƭ ParameterDescriptor: Object

Defines report parameter descriptor

Type declaration

Name Type Description
allowBlank boolean Allow blank
dataType ParameterDataType Parameter data type
dependsOn string[] Parameters on which parameter depends
multiValue boolean Parameter is multivalue
name string Parameter name
nullable boolean Allow null
selectAllValue? any For multivalue parameter special value to indicate that all available values are selected

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

Parameter descriptor.

Defined in

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

ParameterValue

Ƭ ParameterValue: Object

Defines parameter value

Type declaration

Name Type Description
fields? any[] Additional fields for extended parameter view
label string Label to display
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

Type of parameter value

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

Document render options

Type declaration

Name Type Description
galleyMode boolean Renders document without splitting the big content to pages.
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

Defines report parameters

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

Defines special value for multivalue parameter to indicate that all values are set.

Defined in

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

ValidationResult

Ƭ ValidationResult: Object

Parameter validation result

Type declaration

Name Type Description
isValid boolean Indicates whether validation success or not.
message? string The error text in case of validation fails.
value? any New validated parameter value.

Defined in

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

ValidationResults

Ƭ ValidationResults: Object

Parameters validation result

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

Special value to indicate that value is not set.

Defined in

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

selectAll

• selectAll: SelectAllType

Special value for multivalue parameter to indicate that all values are set.

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 Registers and loads user-specified fonts

Parameters

Name Type Description
...fonts FontDescriptor[] Set of font descriptors to be registered

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 ARJS license key

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