py.maidr.ai

maidr_run_command

Runs one of the screen-reader user's own MAIDR commands on a chart, by its id from maidr_list_commands -- for example turning braille or sound off, or starting autoplay -- as if they had pressed its keys where they are: their screen reader, braille display and sonification report the result. Only run a command the user asked for. A toggle steps a mode on rather than setting it: toggle_text goes verbose, terse, off, verbose; toggle_sound turns sound off or on, except on a scatter plot, where sound that is on is combined or separate and goes combined, separate, off, combined. So check `modes` from maidr_list_commands first, run a toggle only as often as reaching what the user asked for takes, and check the `modes` each run returns. Commands that open a dialog or text field are the reader's to use and cannot be run. If the reader has a MAIDR dialog open, nothing runs. Otherwise, if they are not inside the chart, the command waits and runs when they next enter it: tell them so, and do not claim it has happened -- unless you pass focus: true, which moves their keyboard focus into the chart, where the command runs half a second after they hear where they are. Pass focus: true only when the user asked for it to happen now, as in "play it now" -- 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. A result of applied: queued has not run yet either: it waits its turn behind what is waiting for the reader, and has no modes. Apart from that, keyboard focus moves only as the command's own keys would move it.

Page: /

Input schema

{
  "type": "object",
  "properties": {
    "chartId": {
      "type": "string",
      "maxLength": 256,
      "description": "Chart id from maidr_list_charts. May be omitted when the page has exactly one chart."
    },
    "command": {
      "type": "string",
      "enum": [
        "move_left",
        "move_right",
        "move_up",
        "move_down",
        "move_to_left_extreme",
        "move_to_right_extreme",
        "move_to_top_extreme",
        "move_to_bottom_extreme",
        "next_layer",
        "previous_layer",
        "return_to_subplot",
        "enter_grid_cell",
        "announce_point",
        "announce_position",
        "toggle_text",
        "toggle_sound",
        "toggle_braille",
        "toggle_high_contrast",
        "toggle_monitor",
        "autoplay_forward",
        "autoplay_backward",
        "autoplay_upward",
        "autoplay_downward",
        "stop_autoplay",
        "speed_up_autoplay",
        "speed_down_autoplay",
        "reset_autoplay_speed",
        "go_to_min_value",
        "go_to_max_value",
        "next_navigation_mode",
        "previous_navigation_mode",
        "tactile_zoom_in",
        "tactile_zoom_out",
        "tactile_reset_zoom"
      ],
      "description": "A command id maidr_list_commands lists as runnable."
    },
    "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": [
    "command"
  ],
  "additionalProperties": false
}