py.maidr.ai

maidr_navigate

Moves the screen-reader user's cursor in a chart to one data point, for example when they ask to be taken to the highest bar. Address the point with the `target` maidr_get_layer_data gave for it -- row and col, or pointIndex -- passed unchanged; a point without a `target` cannot be navigated to. If the reader is inside the chart, their screen reader, braille display, sonification and highlight announce the new point at once, exactly as a keyboard move would. If they are not, the move waits until they next enter the chart -- unless you pass focus: true, which moves their keyboard focus into the chart and makes the move there, announced as a keyboard move is. Pass focus: true only when the user asked to be taken there now, as in "take me to the highest bar" -- never just because they left the chart, which they did on purpose -- and when the result says focused: true, tell them their focus moved, and into which chart. If they have a MAIDR dialog open, nothing moves, focus included. Whenever the result is not applied: now, tell them what it says, and do not claim they are already there. Only call this when the user asked to be moved.

Page: /

Input schema

{
  "type": "object",
  "properties": {
    "chartId": {
      "type": "string",
      "maxLength": 256
    },
    "layerId": {
      "type": "string",
      "maxLength": 256
    },
    "row": {
      "type": "integer",
      "minimum": 0
    },
    "col": {
      "type": "integer",
      "minimum": 0
    },
    "pointIndex": {
      "type": "integer",
      "minimum": 0
    },
    "focus": {
      "type": "boolean",
      "description": "Move the reader's keyboard focus into the chart, if it is not there, so this happens now. Only when they asked for that. Default false."
    }
  },
  "required": [
    "layerId"
  ],
  "additionalProperties": false
}