[]
DEMO DOCS API
DOWNLOAD
(Showing Draft Content)

Core

Namespace: Core

Table of contents

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AnimationSettings

Ƭ AnimationSettings: Partial<{ charts: Partial<{ highlight: { enabled: boolean } ; onHover: { enabled: boolean } ; onLoad: { enabled: boolean } }> ; table: { onHover: { backgroundColor: string ; enabled: boolean ; textColor?: string } | { enabled: boolean ; textColor: string } } }>

Represents animation settings for visual components.

example

const settings: AnimationSettings = {
	charts: { onLoad: { enabled: true } },
	table: { onHover: { enabled: true, backgroundColor: '#f5f5f5' } },
};

Environment

Ƭ Environment: Object

Represents the report environment used for expression evaluation.

example

const env: Environment = { ReportName: 'SalesReport' };

Type declaration

Name Type Description
EvaluationOptions? { showEvaluationErrors?: boolean ; showExpressionWarnings?: boolean } Gets or sets the evaluation options
EvaluationOptions.showEvaluationErrors? boolean Gets or sets the evaluation error rendering
EvaluationOptions.showExpressionWarnings? boolean Gets or sets the evaluation warning notifications rendering
ReportFolder? string Gets or sets the report folder name.
ReportName? string Gets or sets the report name.
logsSubscriber? RenderLogs -

EventHandler

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

Type parameters

Name Description
TArgs The event arguments type.

Type declaration

▸ (args): void

Represents an event handler callback.

example

const handler: EventHandler<{ id: string }> = (args) => console.log(args.id);
Parameters
Name Type
args TArgs
Returns

void

NoValueType

Ƭ NoValueType: typeof noValue

Defines special value to indicate that value is not set.

Parameter

Ƭ Parameter: Object

Represents a report parameter with values and validation state.

example

const parameter: Parameter = {
	descriptor: {} as ParameterDescriptorEx,
	validValues: [],
	isValidValuesLoaded: false,
	values: [],
	errorMessage: null,
};

Type declaration

Name Type Description
descriptor ParameterDescriptorEx Gets or sets the parameter descriptor.
errorMessage string | null Gets or sets the error message for invalid parameter values.
isValidValuesLoaded boolean Gets or sets a value indicating whether valid values are loaded.
validValues ParameterValue[] Gets or sets the list of valid values.
values ParameterVariant[] Gets or sets the current parameter values.

ParameterDataType

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

Defines parameter data type.

ParameterDescriptor

Ƭ ParameterDescriptor: Object

Represents a report parameter descriptor.

example

const descriptor: ParameterDescriptor = {
	name: 'Year',
	dataType: 'String',
	allowBlank: false,
	nullable: false,
	multiValue: false,
	enableEmptyArray: false,
	dependsOn: [],
	displayFormat: '',
};

Type declaration

Name Type Description
allowBlank boolean Gets or sets a value indicating whether blank values are allowed.
dataType ParameterDataType Gets or sets the parameter data type.
dependsOn string[] Gets or sets the names of parameters this parameter depends on.
displayFormat string Gets or sets the format string used to display values.
enableEmptyArray boolean Gets or sets a value indicating whether an empty array is allowed for multi-value parameters.
multiValue boolean Gets or sets a value indicating whether the parameter is multi-value.
name string Gets or sets the parameter name.
nullable boolean Gets or sets a value indicating whether null values are allowed.
selectAllValue? any Gets or sets the special value that represents "select all" for multi-value parameters.

ParameterDescriptorConfig

Ƭ ParameterDescriptorConfig: Object

Represents the UI configuration for a report parameter.

example

const config: ParameterDescriptorConfig = {
	hidden: false,
	prompt: 'Year',
	multiline: false,
};

Type declaration

Name Type Description
hidden boolean Gets or sets a value indicating whether the parameter is hidden in the parameters panel.
multiline boolean Gets or sets a value indicating whether the prompt supports multiple lines.
prompt string Gets or sets the parameter prompt text.

ParameterDescriptorEx

Ƭ ParameterDescriptorEx: ParameterDescriptor & ParameterDescriptorConfig

Represents a report parameter descriptor with UI configuration.

example

const descriptor: ParameterDescriptorEx = {
	name: 'Year',
	dataType: 'String',
	allowBlank: false,
	nullable: false,
	multiValue: false,
	enableEmptyArray: false,
	dependsOn: [],
	displayFormat: '',
	hidden: false,
	prompt: 'Year',
	multiline: false,
};

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

Represents the document rendering options.

example

const options: RenderOptions = {
	galleyMode: false,
	interactivityActions: [],
};

Type declaration

Name Type Description
forceCellbased? boolean Gets or sets a value indicating whether to force cell-based layout.
galleyMode boolean Gets or sets a value indicating whether to render the document in galley mode.
interactivityActions ({ Data: string ; Type: "toggle" } | { Data: string ; Type: "sort" })[] Gets or sets the interactivity actions applied during rendering. remarks Accepted values: - { Type: 'toggle', Data: string }: Applies a toggle action. - { Type: 'sort', Data: string }: Applies a sort action.

RenderingTreeBarcode

Ƭ RenderingTreeBarcode: RenderingTreeItemBase & { delayedContent?: DelayedContent$1<RenderingTreeBarcode> ; model: { barcodeModel: any ; common: ResolvedItem ; i18n: WithT ; itemViewSize: ItemViewSize ; layer?: string } ; type: "barcode" }

ReportParameters

Ƭ ReportParameters: Object

Represents the report parameters API.

example

const api = {} as ReportParameters;
api.getDescriptors();

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

Represents the contract for resolving external resources by URI.

remarks Implement this type to control how reports resolve external resources such as images, themes, and subreports.

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

Represents a callback that unregisters an event handler.

example

const unregister: UnregisterHandler = () => {};
Returns

void

Variables

CultureInfo

• CultureInfo: Object

Provides data for language and culture-specific text formatting.

example

CultureInfo.registerCulture('en-US', {});

Type declaration

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

CustomCode

• CustomCode: Object

Represents the API for registering user-defined functions.

Type declaration

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

FontStore

• FontStore: Object

Represents the font registration API for CSS and PDF export.

Type declaration

Name Type Description
registerFonts (...fonts: FontDescriptor[]) => Promise<void> & (configUri: string) => Promise<void> Registers fonts in CSS and PDF export. remarks Use the fonts overload to register descriptors directly, or the configUri overload to register from a configuration file. param The font descriptors to register. param The path to a fontsConfig.json file. returns A promise that resolves when the fonts are loaded. example ts const arial: FontDescriptor = { name: 'Arial', source: 'fonts/arial.ttf', style: 'italic', weight: '700', }; const gothic: FontDescriptor = { name: 'MS PGothic', source: 'fonts/MS-PGothic.ttf', }; await FontStore.registerFonts(arial, gothic); example ts await FontStore.registerFonts('./fontsConfig.json');
getFonts () => FontDescriptor[] Gets the registered font descriptors. example ts const fonts = FontStore.getFonts();

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

renderBridge

▸ Const renderBridge(item): null | VNode

Parameters

Name Type
item RenderingTreeBarcode | RenderingTreeChart

Returns

null | VNode

setLicenseKey

▸ setLicenseKey(key): void

Sets the ActiveReportsJS license key.

example

setLicenseKey('YOUR-LICENSE-KEY');

Parameters

Name Type Description
key string The license key value.

Returns

void