Class NotebookTemplateVariable

Notebook template variable.

Hierarchy

  • NotebookTemplateVariable

Constructors

constructor

Properties

_default? availableValues? availableValuesQuery? dataSourceMappings? defaults? name placement? prefix? type?

Constructors

constructor

Properties

Optional _default

_default?: string

(deprecated) The default value for the template variable on notebook load. Cannot be used in conjunction with defaults.

Optional availableValues

availableValues?: string[]

The list of values that the template variable drop-down is limited to.

Optional availableValuesQuery

availableValuesQuery?: NotebookTemplateVariableAvailableValuesQuery

Query used to dynamically populate the list of available values for the template variable.

Optional dataSourceMappings

dataSourceMappings?: {
    [key: string]: string;
}

Mapping of data source names to template variable values.

Type declaration

  • [key: string]: string

Optional defaults

defaults?: string[]

One or many default values for the template variable. Cannot be used in conjunction with default.

name

name: string

The name of the variable.

Optional placement

placement?: string

The placement of the template variable in the notebook.

Optional prefix

prefix?: string

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

Optional type

type?: string

The type of the template variable.

Settings

Member Visibility

Theme

Generated using TypeDoc