This is a type used in Stencila Schema for pointing to a location within source code.

It exists to support diagnostics, references, provenance, and tooling integrations that need to connect document nodes back to specific code spans. By representing locations structurally, Stencila can preserve this information across serialization and execution workflows.

Key properties identify the source, range, and positional information for the code span.

Properties

The CodeLocation type has these properties:

Name	Description	Type	Inherited from
`source`	The source of the code, a file path, label or URL.	`String`	-
`startLine`	The 0-based index if the first line on which the error occurred.	`UnsignedInteger`	-
`startColumn`	The 0-based index if the first column on which the error occurred.	`UnsignedInteger`	-
`endLine`	The 0-based index if the last line on which the error occurred.	`UnsignedInteger`	-
`endColumn`	The 0-based index if the last column on which the error occurred.	`UnsignedInteger`	-
`id`	The identifier for this item.	`String`	`Entity`

The CodeLocation type is related to these types:

Parents: Entity

Children: none

Bindings

The CodeLocation type is represented in:

JSON-LD

JSON Schema

Python class CodeLocation

Rust struct CodeLocation

TypeScript class CodeLocation

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

Properties

Related

Bindings