foxglove.TextAnnotation

A text label on a 2D image

RoboticsObservabilityVisualizationData PlatformPhysical AIAutonomyFleet ManagementDeveloper ToolsMCAPROS

Properties

Name Type Description
timestamp object Timestamp of annotation
position object Bottom-left origin of the text label in 2D image coordinates (pixels). The coordinate uses the top-left corner of the top-left pixel of the image as the origin.
text string Text to display
font_size number Font size in pixels
text_color object Text color
background_color object Background fill color
metadata array Additional user-provided metadata associated with this annotation. Keys must be unique.
View JSON Schema on GitHub

JSON Schema

foxglove-technologies-textannotation.json Raw ↑
{
  "title": "foxglove.TextAnnotation",
  "description": "A text label on a 2D image",
  "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "object",
      "title": "time",
      "properties": {
        "sec": {
          "type": "integer",
          "minimum": 0
        },
        "nsec": {
          "type": "integer",
          "minimum": 0,
          "maximum": 999999999
        }
      },
      "description": "Timestamp of annotation"
    },
    "position": {
      "title": "foxglove.Point2",
      "description": "Bottom-left origin of the text label in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
      "type": "object",
      "properties": {
        "x": {
          "type": "number",
          "description": "x coordinate position"
        },
        "y": {
          "type": "number",
          "description": "y coordinate position"
        }
      },
      "required": [
        "x",
        "y"
      ]
    },
    "text": {
      "type": "string",
      "description": "Text to display"
    },
    "font_size": {
      "type": "number",
      "description": "Font size in pixels"
    },
    "text_color": {
      "title": "foxglove.Color",
      "description": "Text color",
      "type": "object",
      "properties": {
        "r": {
          "type": "number",
          "description": "Red value between 0 and 1"
        },
        "g": {
          "type": "number",
          "description": "Green value between 0 and 1"
        },
        "b": {
          "type": "number",
          "description": "Blue value between 0 and 1"
        },
        "a": {
          "type": "number",
          "description": "Alpha value between 0 and 1"
        }
      },
      "required": [
        "r",
        "g",
        "b",
        "a"
      ]
    },
    "background_color": {
      "title": "foxglove.Color",
      "description": "Background fill color",
      "type": "object",
      "properties": {
        "r": {
          "type": "number",
          "description": "Red value between 0 and 1"
        },
        "g": {
          "type": "number",
          "description": "Green value between 0 and 1"
        },
        "b": {
          "type": "number",
          "description": "Blue value between 0 and 1"
        },
        "a": {
          "type": "number",
          "description": "Alpha value between 0 and 1"
        }
      },
      "required": [
        "r",
        "g",
        "b",
        "a"
      ]
    },
    "metadata": {
      "type": "array",
      "items": {
        "title": "foxglove.KeyValuePair",
        "description": "A key with its associated value",
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Key"
          },
          "value": {
            "type": "string",
            "description": "Value"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "description": "Additional user-provided metadata associated with this annotation. Keys must be unique."
    }
  },
  "required": [
    "timestamp",
    "position",
    "text",
    "font_size",
    "text_color",
    "background_color"
  ]
}