IReportVariableDefinition

Home > @gooddata/sdk-model > IReportVariableDefinition

IReportVariableDefinition interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

A custom variable declared by report content and given a value by a report.

Signature:

export interface IReportVariableDefinition 

Remarks

Referenced from text as {{name}}. Values come from IReportBase.variableValues, falling back to IReportVariableDefinition.defaultValue.

Properties

Property	Modifiers	Type	Description
defaultValue?		string	(ALPHA) (Optional) Value used when the report does not provide one. May not contain further placeholders — there is no recursive expansion.
description?		string	(ALPHA) (Optional)
name		string	(ALPHA) Variable name as used inside the {{...}} marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/. Built-in names (ReportBuiltInVariable) are reserved.
title?		string	(ALPHA) (Optional) Human readable label shown in the editor.