This is a type used in Stencila Schema for named values in executable and structured content.

It exists to pair a symbolic name with a value within the document model, supporting computation, templating, and data exchange workflows. Representing variables structurally makes them easier to inspect, validate, and serialize than ad hoc key-value text.

Key properties include the variable name and value, along with any associated metadata or hints.

This type is marked as unstable and is subject to change.

Analogues

The following external types, elements, or nodes are similar to a Variable:

programming language variable binding: Close conceptual analogue for a named value, though Stencila exposes variables as document-model nodes with type hints and serialization semantics.

Properties

The Variable type has these properties:

Name	Description	Type	Inherited from
`name`	The name of the variable.	`String`	-
`programmingLanguage`	The programming language that the variable is defined in e.g. Python, JSON.	`String`	-
`nativeType`	The native type of the variable e.g. `float`, `datetime.datetime`, `pandas.DataFrame`	`String`	-
`nodeType`	The Stencila node type of the variable e.g. `Number`, `DateTime`, `Datatable`.	`String`	-
`value`	The value of the variable.	`Node`	-
`hint`	A hint to the value and/or structure of the variable.	`Hint`	-
`nativeHint`	A textual hint to the value and/or structure of the variable.	`String`	-
`id`	The identifier for this item.	`String`	`Entity`

The Variable type is related to these types:

Parents: Entity

Children: none

Bindings

The Variable type is represented in:

JSON-LD

JSON Schema

Python class Variable

Rust struct Variable

TypeScript class Variable

This documentation was generated from Variable.yaml by docs_types.rs.

Analogues

Properties

Related

Bindings