IReportVariableDefinition
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
A custom variable declared by report content and given a value by a report.
export interface IReportVariableDefinition
Remarks
Referenced from text as {name}. Values come from IReportBase.variableValues, falling back to IReportVariableDefinition.defaultValue.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Value used when the report does not provide one. May not contain further placeholders — there is no recursive expansion. | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) Variable name as used inside the | ||
string | (ALPHA) (Optional) Human readable label shown in the editor. |
Property details
IReportVariableDefinition.defaultValuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Value used when the report does not provide one. May not contain further placeholders — there is no recursive expansion.
defaultValue?: string;
IReportVariableDefinition.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
description?: string;
IReportVariableDefinition.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Variable name as used inside the {...} marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/. Built-in names (ReportBuiltInVariable) are reserved.
name: string;
IReportVariableDefinition.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Human readable label shown in the editor.
title?: string;