[]
Ƭ Environment: Object
Report environment used for expressions calculation.
Name | Type | Description |
---|---|---|
ReportFolder? |
string |
Report directory name |
ReportName? |
string |
Report name |
Ƭ EventHandler<TArgs
>: (args
: TArgs
) => void
Name | Description |
---|---|
TArgs |
event argument type |
▸ (args
): void
Event Handler
Name | Type |
---|---|
args |
TArgs |
void
Ƭ NoValueType: typeof noValue
Defines special value to indicate that value is not set.
Ƭ Parameter: Object
Defines report parameter
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: "Boolean"
| "String"
| "Integer"
| "Float"
| "Date"
| "DateTime"
Defines parameter data type.
Ƭ ParameterDescriptor: Object
Defines report parameter descriptor
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 |
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: Object
Parameter visual presentation settings.
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: ParameterDescriptor
& ParameterDescriptorConfig
Parameter descriptor.
Ƭ ParameterValue: Object
Defines parameter value
Name | Type | Description |
---|---|---|
fields? |
any [] |
Additional fields for extended parameter view |
label |
string |
Label to display |
value |
ParameterVariant |
Value |
Ƭ ParameterVariant: string
| number
| boolean
| Date
| null
| NoValueType
| SelectAllType
Type of parameter value
Ƭ RenderOptions: Object
Document render options
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: Object
Defines report parameters
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 > |
validate |
() => ValidationResults |
Ƭ ResourceLocator: Object
Provide tools for accessing external resources by URIs.
Name | Type |
---|---|
fork |
(reportName : string ) => ResourceLocator |
getResource |
<T>(uri : string ) => Promise <null | T > |
getResourceUri |
(resourceID : string ) => string |
Ƭ SelectAllType: Object
Defines special value for multivalue parameter to indicate that all values are set.
Ƭ UnregisterHandler: () => void
▸ (): void
Unsubscribe event handler
void
Ƭ ValidationResult: Object
Parameter validation result
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: Object
Parameters validation result
▪ [parameter: string
]: ValidationResult
Dictionary with validation results per parameter
• CultureInfo: Object
Provides data for language and culture specific text formatting.
Name | Type |
---|---|
registerCulture |
(identifier : string , data : LocaleData ) => void |
• CustomCode: Object
Provides tool for registering user defined functions.
Name | Type |
---|---|
getFunctions |
() => UserDefinedFunction [] |
registerFunctions |
(functions : UserDefinedFunction []) => void |
• FontStore: Object
Provides tools for registering fonts in CSS and pdf export.
Name | Type |
---|---|
registerFonts |
(...fonts : FontDescriptor []) => Promise <void > & (configUri : string ) => Promise <void > |
getFonts |
() => FontDescriptor [] |
• noValue: undefined
Special value to indicate that value is not set.
• selectAll: SelectAllType
Special value for multivalue parameter to indicate that all values are set.
▸ registerFont(...fonts
): Promise
<void
>
deprecated
Use FontStore.registerFonts instead
Registers and loads user-specified fonts
Name | Type | Description |
---|---|---|
...fonts |
FontDescriptor [] |
Set of font descriptors to be registered |
Promise
<void
>
Promise that will be resolved when all fonts are loaded and ready for render
▸ setLicenseKey(key
): void
Set ARJS license key
Name | Type | Description |
---|---|---|
key |
string |
license key value |
void