work.sequential.feed.annotation

sequential.work

Documentation

A note pinned to a point on a page, slice or strip. Anyone can write one in their own repo; AppViews decide whose annotations to show, e.g. only those from the repo that owns the subject.

main record

A note pinned to a point on a page, slice or strip. Anyone can write one in their own repo; AppViews decide whose annotations to show, e.g. only those from the repo that owns the subject.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

The date and time the annotation was created.

subject string at-uri Required

AT-URI of the work.sequential.page, work.sequential.slice or work.sequential.strip being annotated. AppViews ignore annotations on any other record. Use the DID form (at://did:...), not a handle.

x integer Required

Horizontal position of the annotation, in ten-thousandths of the image's width (0-10000), from the left.

minimum: 0maximum: 10000
y integer Required

Vertical position of the annotation, in ten-thousandths of the image's height (0-10000), from the top.

minimum: 0maximum: 10000
View raw schema
{
  "description": "A note pinned to a point on a page, slice or strip. Anyone can write one in their own repo; AppViews decide whose annotations to show, e.g. only those from the repo that owns the subject.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "The date and time the annotation was created.",
        "format": "datetime",
        "type": "string"
      },
      "subject": {
        "description": "AT-URI of the work.sequential.page, work.sequential.slice or work.sequential.strip being annotated. AppViews ignore annotations on any other record. Use the DID form (at://did:...), not a handle.",
        "format": "at-uri",
        "type": "string"
      },
      "text": {
        "description": "Localized annotation text.",
        "items": {
          "ref": "work.sequential.defs#localizedText",
          "type": "ref"
        },
        "maxLength": 100,
        "minLength": 1,
        "type": "array"
      },
      "x": {
        "description": "Horizontal position of the annotation, in ten-thousandths of the image's width (0-10000), from the left.",
        "maximum": 10000,
        "minimum": 0,
        "type": "integer"
      },
      "y": {
        "description": "Vertical position of the annotation, in ten-thousandths of the image's height (0-10000), from the top.",
        "maximum": 10000,
        "minimum": 0,
        "type": "integer"
      }
    },
    "required": [
      "subject",
      "x",
      "y",
      "text",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@