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

Properties

The Variable type has these properties:

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

Related

The Variable type is related to these types:

• Parents: Entity
• Children: none

Formats

The Variable type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🔷 Low loss
JATS
Markdown	⚠️ High loss
Stencila Markdown	⚠️ High loss
Quarto Markdown	⚠️ High loss
MyST Markdown	⚠️ High loss
LLM Markdown	⚠️ High loss
LaTeX	🔷 Low loss	🔷 Low loss
PDF	🔷 Low loss
Plain text	⚠️ High loss
IPYNB	🔷 Low loss	🔷 Low loss
Microsoft Word DOCX	🔷 Low loss	🔷 Low loss
OpenDocument ODT	🔷 Low loss	🔷 Low loss
TeX	🔷 Low loss	🔷 Low loss
JSON	🟢 No loss	🟢 No loss
JSON+Zip	🟢 No loss	🟢 No loss
JSON5	🟢 No loss	🟢 No loss
JSON-LD	🟢 No loss	🟢 No loss
CBOR	🟢 No loss	🟢 No loss
CBOR+Zstandard	🟢 No loss	🟢 No loss
YAML	🟢 No loss	🟢 No loss
Lexical JSON	🔷 Low loss	🔷 Low loss
Koenig JSON	🔷 Low loss	🔷 Low loss
Pandoc AST	🔷 Low loss	🔷 Low loss
Directory
Stencila Web Bundle
Debug	🔷 Low loss

Bindings

The Variable type is represented in:

• JSON-LD
• JSON Schema
• Python class Variable
• Rust struct Variable
• TypeScript class Variable

Source

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