Namespace: Core

Table of contents

Namespaces

• Rdl

Classes

• PageDocument
• PageReport

Interfaces

• Event
• FontDescriptor

Type aliases

• Environment
• EventHandler
• NoValueType
• Parameter
• ParameterDataType
• ParameterDescriptor
• ParameterDescriptorConfig
• ParameterDescriptorEx
• ParameterValue
• ParameterVariant
• RenderOptions
• ReportParameters
• ResourceLocator
• SelectAllType
• UnregisterHandler

Variables

• CultureInfo
• CustomCode
• FontStore
• noValue
• selectAll

Functions

• setLicenseKey

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

---

EventHandler

Ƭ EventHandler<TArgs>: (args: TArgs) => void

Type parameters

Name	Description
TArgs	event argument type

Type declaration

▸ (args): void

Event Handler

Parameters

Name	Type
args	TArgs

Returns

void

---

NoValueType

Ƭ NoValueType: typeof noValue

Defines special value to indicate that value is not set.

---

Parameter

Ƭ Parameter: Object

Defines report parameter

Type declaration

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

---

ParameterDataType

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

Defines parameter data type.

---

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
displayFormat	string	Format to display value
enableEmptyArray	boolean	Specifies whether this parameter can have an empty array as its value. This setting is only available for multi-valued parameters
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

---

ParameterDescriptorConfig

Ƭ ParameterDescriptorConfig: Object

Parameter visual presentation settings.

Type declaration

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

---

ParameterDescriptorEx

Ƭ ParameterDescriptorEx: ParameterDescriptor & ParameterDescriptorConfig

Parameter descriptor.

---

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

---

ParameterVariant

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

Type of parameter value

---

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.

---

ReportParameters

Ƭ ReportParameters: Object

Defines report parameters

Type declaration

Name	Type
applySteps	(steps: ApplyParameterStep[]) => Promise<void>
getDescriptors	() => { [name: string]: ParameterDescriptorEx; }
getValues	() => { [name: string]: ParameterState; }
getValuesFor	(knownValues: { [name: string]: ParameterVariant | ParameterVariant[]; }, requiredParameters: { [name: string]: { fields: string[] } | null; }) => Promise<GetValuesResult>

---

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

---

SelectAllType

Ƭ SelectAllType: Object

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

---

UnregisterHandler

Ƭ UnregisterHandler: () => void

Type declaration

▸ (): void

Unsubscribe event handler

Returns

void

Variables

CultureInfo

• CultureInfo: Object

Provides data for language and culture specific text formatting.

Type declaration

Name	Type
registerCulture	(identifier: string, data: any) => void

---

CustomCode

• CustomCode: Object

Provides tool for registering user defined functions.

Type declaration

Name	Type
getFunctions	() => UserDefinedFunction[]
registerFunctions	(functions: UserDefinedFunction[]) => void

---

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[]

---

noValue

• noValue: undefined

Special value to indicate that value is not set.

---

selectAll

• selectAll: SelectAllType

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

Functions

setLicenseKey

▸ setLicenseKey(key): void

Set ARJS license key

Parameters

Name	Type	Description
key	string	license key value

Returns

void