Core
Namespace: Core
Table of contents
Namespaces
Classes
Interfaces
Type aliases
- Environment
- NoValueType
- Parameter
- ParameterDataType
- ParameterDescriptor
- ParameterDescriptorConfig
- ParameterDescriptorEx
- ParameterValue
- ParameterVariant
- RenderOptions
- ReportParameters
- ResourceLocator
- SelectAllType
- ValidationResult
- ValidationResults
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 |
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 |
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
Index signature
▪ [name: string]: Parameter
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.
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. |
ValidationResults
Ƭ ValidationResults: Object
Parameters validation result
Index signature
▪ [parameter: string]: ValidationResult
Dictionary with validation results per parameter
Variables
CultureInfo
• CultureInfo: Object
Provides data for language and culture specific text formatting.
Type declaration
| Name | Type |
|---|---|
registerCulture |
(identifier: string, data: LocaleData) => 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
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
setLicenseKey
▸ setLicenseKey(key): void
Set ARJS license key
Parameters
| Name | Type | Description |
|---|---|---|
key |
string |
license key value |
Returns
void