OPF

Search docs

Loading documentation…
    OpenPresentation/opf
    Browse docs
    On this page
    View source

    Image Callout

    Metadata

    Definition
    #/$defs/ImageCallout
    Form
    object
    Source
    spec/schemas/opf.schema.json

    Field index

    FieldTypeReq.Description
    textstringyesPlain editable text. Native edits preserve current words; an empty string is retained.
    xref:FiniteNumberyesSigned fraction of the visible image frame width from its physical left edge. A callout points at pixels, and a picture never mirrors, so this coordinate is physical in every language. Negative values or values greater than 1 position the panel outside the image; its text is not clipped to the image. The slide crops what lies outside it.
    yref:FiniteNumberyesSigned fraction of the visible image frame height from its physical top edge. Negative values or values greater than 1 position the panel outside the image; its text is not clipped to the image. The slide crops what lies outside it.
    widthnumberyesPositive fraction of the visible image frame width, at most 1. The signed x origin controls placement outside the frame.
    heightnumberyesPositive fraction of the visible image frame height, at most 1. The signed y origin controls placement outside the frame.

    text

    typestringrequiredyesdefault—

    Plain editable text. Native edits preserve current words; an empty string is retained.

    x

    typeref:FiniteNumberrequiredyesdefault—

    Signed fraction of the visible image frame width from its physical left edge. A callout points at pixels, and a picture never mirrors, so this coordinate is physical in every language. Negative values or values greater than 1 position the panel outside the image; its text is not clipped to the image. The slide crops what lies outside it.

    y

    typeref:FiniteNumberrequiredyesdefault—

    Signed fraction of the visible image frame height from its physical top edge. Negative values or values greater than 1 position the panel outside the image; its text is not clipped to the image. The slide crops what lies outside it.

    width

    typenumberrequiredyesdefault—

    Positive fraction of the visible image frame width, at most 1. The signed x origin controls placement outside the frame.

    height

    typenumberrequiredyesdefault—

    Positive fraction of the visible image frame height, at most 1. The signed y origin controls placement outside the frame.

    Complete definition constraints
    Schema constraints
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "text",
        "x",
        "y",
        "width",
        "height"
      ],
      "properties": {
        "text": {
          "type": "string",
          "description": "Plain editable text. Native edits preserve current words; an empty string is retained."
        },
        "x": {
          "$ref": "#/$defs/FiniteNumber",
          "description": "Signed fraction of the visible image frame width from its physical left edge. A callout points at pixels, and a picture never mirrors, so this coordinate is physical in every language. Negative values or values greater than 1 position the panel outside the image; its text is not clipped to the image. The slide crops what lies outside it."
        },
        "y": {
          "$ref": "#/$defs/FiniteNumber",
          "description": "Signed fraction of the visible image frame height from its physical top edge. Negative values or values greater than 1 position the panel outside the image; its text is not clipped to the image. The slide crops what lies outside it."
        },
        "width": {
          "type": "number",
          "exclusiveMinimum": 0,
          "maximum": 1,
          "description": "Positive fraction of the visible image frame width, at most 1. The signed x origin controls placement outside the frame."
        },
        "height": {
          "type": "number",
          "exclusiveMinimum": 0,
          "maximum": 1,
          "description": "Positive fraction of the visible image frame height, at most 1. The signed y origin controls placement outside the frame."
        }
      }
    }