Input.synthesizeScrollGesture

Synthesizes a scroll gesture over a time period by issuing appropriate touch events.

{
  "name": "synthesizeScrollGesture",
  "async": true,
  "parameters": [
    {
      "name": "x",
      "type": "integer",
      "description": "X coordinate of the start of the gesture in CSS pixels."
    },
    {
      "name": "y",
      "type": "integer",
      "description": "Y coordinate of the start of the gesture in CSS pixels."
    },
    {
      "name": "xDistance",
      "type": "integer",
      "optional": true,
      "description": "The distance to scroll along the X axis (positive to scroll left)."
    },
    {
      "name": "yDistance",
      "type": "integer",
      "optional": true,
      "description": "The distance to scroll along the Y axis (positive to scroll up)."
    },
    {
      "name": "xOverscroll",
      "type": "integer",
      "optional": true,
      "description": "The number of additional pixels to scroll back along the X axis, in addition to the given distance."
    },
    {
      "name": "yOverscroll",
      "type": "integer",
      "optional": true,
      "description": "The number of additional pixels to scroll back along the Y axis, in addition to the given distance."
    },
    {
      "name": "preventFling",
      "type": "boolean",
      "optional": true,
      "description": "Prevent fling (default: true)."
    },
    {
      "name": "speed",
      "type": "integer",
      "optional": true,
      "description": "Swipe speed in pixels per second (default: 800)."
    },
    {
      "name": "gestureSourceType",
      "$ref": "GestureSourceType",
      "optional": true,
      "description": "Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type)."
    },
    {
      "name": "repeatCount",
      "type": "integer",
      "optional": true,
      "description": "The number of times to repeat the gesture (default: 0)."
    },
    {
      "name": "repeatDelayMs",
      "type": "integer",
      "optional": true,
      "description": "The number of milliseconds delay between each repeat. (default: 250)."
    },
    {
      "name": "interactionMarkerName",
      "type": "string",
      "optional": true,
      "description": "The name of the interaction markers to generate, if not empty (default: \"\")."
    }
  ],
  "description": "Synthesizes a scroll gesture over a time period by issuing appropriate touch events.",
  "experimental": true,
  "handlers": [
    "browser"
  ]
}