Skip to main content

Variable

A variable representing a name / value pair.

This schema type is marked as experimental ๐Ÿงช and is subject to change.

Propertiesโ€‹

Name@idTypeDescriptionInherited from
nameschema:namestringThe name of the variable. See note 1.Variable
idschema:idstringThe identifier for this item.Entity
isReadonlyschema:readonlyValuebooleanWhether or not a property is mutable. Default is false. See note 2.Variable
metastencila:metaobjectMetadata associated with this item.Entity
validatorstencila:validatorValidatorTypesThe validator that the value is validated against.Variable
valueschema:valueNodeThe value of the variable.Variable

Notesโ€‹

  1. name : This regex allows for snake_case and camelCase names but excludes PascalCase for names.
  2. isReadonly : If isReadonly is true and value is defined then changes to value should not be allowed.
  • Parent: Entity
  • Descendants: None

Available asโ€‹

Sourceโ€‹

This documentation was generated from Variable.schema.yaml.