IAutomationParameter

Home > @gooddata/sdk-ui-dashboard > IAutomationParameter

IAutomationParameter 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 workspace parameter resolved for display and editing inside an automation (alert/schedule) dialog. The value is the current effective value the headless run will capture; definition picks which control renders.

Signature:

export interface IAutomationParameter

Properties

Property

Modifiers

Type

Description

definition

IParameterDefinition

(ALPHA) Resolved definition of the parameter; determines which editing control the chip renders.

mode

DashboardParameterMode

(ALPHA) Dashboard-level mode of the parameter, controlling whether its chip is editable in the dialog.

ref

IdentifierRef

(ALPHA) Reference to the workspace parameter this row represents.

title

string

(ALPHA) Title shown on the parameter chip: the dashboard-level label when the dashboard defines one, otherwise the workspace parameter's title, otherwise the identifier.

value

ParameterValue

(ALPHA) The current effective value — the value a headless run of the automation will capture.

← IAutomationFiltersTabIAutomationsContextValue →