Metadata

The Metadata extension allows you to view metadata for each cell, configured during project creation. This metadata can be embedded within any compatible input file format that supports metadata, such as JSON Advanced, Datasaur Schema, or by using the Import File Transformer.

Metadata can be added to Span and Row Labeling projects.

• In Span Labeling, it is available per line.

Metadata Example in Span Labeling Project

• While in Row Labeling, it is available per cell.

Metadata Example in Row Labeling Project

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 field indicating the type of the value in MIME type.

  • Default: text/plain

  • Supported type:

    • text/plain: Displays metadata as plain text.

    • text/html: Displays metadata as HTML.

    • image/*: Displays metadata as an image. The supported image format will depend on the browser support.
    • audio/*: Displays metadata as an audio player. The supported audio format will depend on the browser support.
• pinned: Boolean that specifies if the metadata should be visible at the top of each cell. Metadata that isn’t pinned will still be viewable through the Metadata Extension panel.

• config: Customizes appearance for text/plain types.

  • color: Determine the text color of the metadata in string. Accepts any HTML color codes and names.

  • backgroundColor: Determine the background color of the metadata in string. Accepts any HTML color codes and names.

  • borderColor: Determine the border color of the metadata in string. Accepts any HTML color codes and names.

Here’s a sample that can be used for creating a Span Labeling project that contains metadata.

11KB

Datasaur Sample - Span Labeling with Metadata (1).json

4KB

Datasaur Sample - Row Labeling with Metadata.json