Metadata

View additional metadata attached to lines or cells within your project.

The Metadata extension allows you to view metadata attached to cells or lines in a project. Metadata can be embedded in input formats that support metadata, such as JSON Advanced, Datasaur Schema, or by using the Import File Transformer.

Metadata is supported in:

Span labeling projects: Metadata is attached per line.
Row labeling projects: Metadata is attached per cell.

Structure

The structure for CellMetadata is defined as follows:

CellMetadata {
    key: string;
    value: string;
    type?: string;
    pinned?: boolean;
    config?: {
        backgroundColor: string;
        color: string;
        borderColor: string;
    }
}

Metadata object structure:

key: Identifier for the metadata item, represented as a string. Example: "author" .
value: Content or data of the metadata item, represented as a string. Example: "John Doe" .
type (optional): MIME type used to display the metadata.
- Default: text/plain
- Supported types:
  - text/plain: Displays metadata as plain text.
  - text/html: Displays metadata as HTML content.
  - image/*: Displays metadata as an image. Supported image formats depend on browser support.
  - audio/*: Displays metadata as an audio player. Supported audio formats depend on browser support.
pinned (optional): If true, the metadata appears at the top of the cell. Otherwise, it is available in the Metadata extension panel.
config (optional): Customizes the appearance of text/plain metadata. All color fields support standard HTML color names and color codes.
- color: Determines the text color of the metadata.
- backgroundColor: Determines the background color of the metadata.
- borderColor: Determines the border color of the metadata.