This is an executable type used in Stencila Schema for forms that batch updates to document parameters.

It extends Executable so forms can derive values, trigger updates, and participate in reactive document workflows rather than being treated as passive UI markup. This makes forms part of the executable document model.

Key properties include form content, derive actions, parameter bindings, and inherited execution metadata.

This type is marked as experimental and is likely to change.

Properties

The Form type has these properties:

Name	Description	Type	Inherited from
`content`	The content within the form, usually containing at least one `Parameter`.	`Block`*	-
`deriveFrom`	The dotted path to the object (e.g a database table) that the form should be derived from	`String`	-
`deriveAction`	The action (create, update or delete) to derive for the form	`FormDeriveAction`	-
`deriveItem`	An identifier for the item to be the target of Update or Delete actions	`Integer` \| `String`	-
`executionMode`	Under which circumstances the node should be executed.	`ExecutionMode`	`Executable`
`compilationDigest`	A digest of the content, semantics and dependencies of the node.	`CompilationDigest`	`Executable`
`compilationMessages`	Messages generated while compiling the code.	`CompilationMessage`*	`Executable`
`executionDigest`	The `compilationDigest` of the node when it was last executed.	`CompilationDigest`	`Executable`
`executionDependencies`	The upstream dependencies of this node.	`ExecutionDependency`*	`Executable`
`executionDependants`	The downstream dependants of this node.	`ExecutionDependant`*	`Executable`
`executionTags`	Tags in the code which affect its execution.	`ExecutionTag`*	`Executable`
`executionCount`	A count of the number of times that the node has been executed.	`Integer`	`Executable`
`executionRequired`	Whether, and why, the code requires execution or re-execution.	`ExecutionRequired`	`Executable`
`executionStatus`	Status of the most recent, including any current, execution.	`ExecutionStatus`	`Executable`
`executionInstance`	The id of the kernel instance that performed the last execution.	`String`	`Executable`
`executionEnded`	The timestamp when the last execution ended.	`Timestamp`	`Executable`
`executionDuration`	Duration of the last execution.	`Duration`	`Executable`
`executionMessages`	Messages emitted while executing the node.	`ExecutionMessage`*	`Executable`
`id`	The identifier for this item.	`String`	`Entity`

The Form type is related to these types:

Parents: Executable

Children: none

Bindings

The Form type is represented in:

JSON-LD

JSON Schema

Python class Form

Rust struct Form

TypeScript class Form

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

Properties

Related

Bindings