page.corvus.facets

corvus.page

Documentation

A facet

main object

A facet

Properties

index ref #index Required

The atom range this facet covers

View raw schema
{
  "type": "object",
  "required": [
    "index"
  ],
  "properties": {
    "index": {
      "ref": "#index",
      "type": "ref",
      "description": "The atom range this facet covers"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#bold",
          "#italic",
          "#underline",
          "#strikethrough",
          "#link",
          "#highlight"
        ],
        "type": "union",
        "closed": false
      },
      "description": "The features applied to the facet"
    }
  },
  "description": "A facet"
}
bold object

A bold facet

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "A bold facet"
}
dateTime object

A date/time facet

Properties

dateOnly boolean Optional

True if the time component should be ignored - defaults to false

value string datetime Optional

The date/time value

View raw schema
{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "format": "datetime",
      "description": "The date/time value"
    },
    "dateOnly": {
      "type": "boolean",
      "default": false,
      "description": "True if the time component should be ignored - defaults to false"
    }
  },
  "description": "A date/time facet"
}
highlight object

A highlight facet

Properties

color string Optional

The color of the highlight

View raw schema
{
  "type": "object",
  "properties": {
    "color": {
      "type": "string",
      "description": "The color of the highlight"
    }
  },
  "description": "A highlight facet"
}
index object

An atom range of a facet

Properties

atomEnd string Required

The end atom id of the facet (inclusive) - formatted as `operationId.atomIdx`

atomStart string Required

The start atom id of the facet (inclusive) - formatted as `operationId.atomIdx`

View raw schema
{
  "type": "object",
  "required": [
    "atomStart",
    "atomEnd"
  ],
  "properties": {
    "atomEnd": {
      "type": "string",
      "description": "The end atom id of the facet (inclusive) - formatted as `operationId.atomIdx`"
    },
    "atomStart": {
      "type": "string",
      "description": "The start atom id of the facet (inclusive) - formatted as `operationId.atomIdx`"
    }
  },
  "description": "An atom range of a facet"
}
italic object

An italic facet

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "An italic facet"
}
link object

A link facet

Properties

url string uri Optional

The URL of the linked resource

View raw schema
{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the linked resource"
    }
  },
  "description": "A link facet"
}
mention object

A mention facet

Properties

did string did Optional

The did of the mentioned user

View raw schema
{
  "type": "object",
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "The did of the mentioned user"
    }
  },
  "description": "A mention facet"
}
strikethrough object

A strikethrough facet

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "A strikethrough facet"
}
underline object

An underline facet

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "An underline facet"
}

Lexicon Garden

@