Code Location
The location within some source code.
Properties
The CodeLocation
type has these properties:
Name | Description | Type | Inherited from | JSON-LD @id |
Aliases |
---|---|---|---|---|---|
id |
The identifier for this item. | String |
Entity |
schema:id |
- |
source |
The source of the code, a file path, label or URL. | String |
- | stencila:source |
- |
startLine |
The 0-based index if the first line on which the error occurred. | UnsignedInteger |
- | stencila:startLine |
start-line , start_line |
startColumn |
The 0-based index if the first column on which the error occurred. | UnsignedInteger |
- | stencila:startColumn |
start-column , start_column |
endLine |
The 0-based index if the last line on which the error occurred. | UnsignedInteger |
- | stencila:endLine |
end-line , end_line |
endColumn |
The 0-based index if the last column on which the error occurred. | UnsignedInteger |
- | stencila:endColumn |
end-column , end_column |
Related
The CodeLocation
type is related to these types:
- Parents:
Entity
- Children: none
Formats
The CodeLocation
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 | ||
🔷 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 CodeLocation
type is represented in:
- JSON-LD
- JSON Schema
- Python class
CodeLocation
- Rust struct
CodeLocation
- TypeScript class
CodeLocation
Source
This documentation was generated from CodeLocation.yaml
by docs_types.rs
.