Hit Regions

A <a href="#hit-region">hit region</a> A is an ancestor region of a <a href="#hit-region">hit region</a> B if B has a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> and its <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> is either A or another <a href="#hit-region">hit region</a> for which A is an <a href="#ancestor-region">ancestor region</a>.

The region identified by the ID ID in a bitmap bitmap is the value returned by the following algorithm (which can return a <a href="#hit-region">hit region</a> or nothing):

1. If ID is null, return nothing and abort these steps.

2. Let list be the <a href="#hit-region-list">hit region list</a> associated with bitmap.

3. If there is a <a href="#hit-region">hit region</a> in list whose <a data-anolis-xref="hit region's ID" href="#hit-region%27s-id">ID</a> is a case-sensitive match for ID, then return that <a href="#hit-region">hit region</a> and abort these steps.

4. Otherwise, return nothing.

The region representing the control control for a bitmap bitmap is the value returned by the following algorithm (which can return a <a href="#hit-region">hit region</a> or nothing):

1. Let list be the <a href="#hit-region-list">hit region list</a> associated with bitmap.

2. If there is a <a href="#hit-region">hit region</a> in list whose <a data-anolis-xref="hit region's control" href="#hit-region%27s-control">control</a> is control, then return that <a href="#hit-region">hit region</a> and abort these steps.

3. Otherwise, return nothing.

The control represented by a region region for a canvas element ancestor is the value returned by the following algorithm (which can return an element or nothing):

1. If region has no <a data-anolis-xref="hit region's control" href="#hit-region%27s-control">control</a>, return nothing and abort these steps.

2. Let control be region's <a data-anolis-xref="hit region's control" href="#hit-region%27s-control">control</a>.

3. If control is not a descendant of ancestor, then return nothing and abort these steps.

4. Otherwise, return control.

The cursor for a hit region region of a canvas element ancestor is the value returned by the following algorithm:

1. Loop: If region has a <a data-anolis-xref="hit region's cursor specification" href="#hit-region%27s-cursor-specification">cursor specification</a> other than "inherit", then return that <a href="#hit-region%27s-cursor-specification">hit region's cursor specification</a> and abort these steps.

2. If region has a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a>, then let region be that <a href="#hit-region%27s-parent">hit region's parent</a>, and return to the step labeled loop.

3. Otherwise, return the used value of the 'cursor' property for the canvas element, if any; if there isn't one, return 'auto'. <a href="#refsCSSUI">[CSSUI]</a>

The region for a pixel pixel on a bitmap bitmap is the value returned by the following algorithm (which can return a <a href="#hit-region">hit region</a> or nothing):

1. Let list be the <a href="#hit-region-list">hit region list</a> associated with bitmap.

2. If there is a <a href="#hit-region">hit region</a> in list whose <a data-anolis-xref="hit region's set of pixels" href="#hit-region%27s-set-of-pixels">set of pixels</a> contains pixel, then return that <a href="#hit-region">hit region</a> and abort these steps.

3. Otherwise, return nothing.

To clear regions that cover the pixels pixels on a bitmap bitmap, the user agent must run the following steps:

1. Let list be the <a href="#hit-region-list">hit region list</a> associated with bitmap.

2. Remove all pixels in pixels from the <a data-anolis-xref="hit region's set of pixels" href="#hit-region%27s-set-of-pixels">set of pixels</a> of each <a href="#hit-region">hit region</a> in list.

3. <a href="#garbage-collect-the-regions">Garbage-collect the regions</a> of bitmap.

To garbage-collect the regions of a bitmap bitmap, the user agent must run the following steps:

1. Let list be the <a href="#hit-region-list">hit region list</a> associated with bitmap.

2. Loop: Let victim be the first <a href="#hit-region">hit region</a> in list to have an empty <a data-anolis-xref="hit region's set of pixels" href="#hit-region%27s-set-of-pixels">set of pixels</a> and a zero <a data-anolis-xref="hit region's child count" href="#hit-region%27s-child-count">child count</a>, if any. If there is no such <a href="#hit-region">hit region</a>, abort these steps.

3. If victim has a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a>, then decrement that <a href="#hit-region%27s-child-count">hit region's child count</a> by one.

4. Remove victim from list.

5. Jump back to the step labeled loop.

Adding a new region and calling <a href="#dom-context-2d-clearrect">clearRect()</a> are the two ways this clearing algorithm can be invoked. The <a href="#hit-region-list">hit region list</a> itself is also reset when the rendering context is reset, e.g. when a <a href="#canvasrenderingcontext2d">CanvasRenderingContext2D</a> object is bound to or unbound from a canvas, or when the dimensions of the bitmap are changed.

---

When the addHitRegion() method is invoked, the user agent must run the following steps:

1. Let arguments be the dictionary object provided as the method's argument.

2. If the arguments object's path member is not null, let source path be the path member's value. Otherwise, let it be the <a href="#canvasrenderingcontext2d">CanvasRenderingContext2D</a> object's <a href="#current-default-path">current default path</a>.

3. Transform all the coordinates and lines in source path by the current transform matrix, if the arguments object's path member is not null.

4. Let specified pixels be the pixels contained in source path, using the <a href="#fill-rule">fill rule</a> indicated by the fillRule member.

5. If the arguments object's id member is the empty string, let it be null instead.

6. If the arguments object's id member is not null, then let previous region for this ID be <a href="#the-region-identified-by-the-id">the region identified by the ID</a> given by the id member's value in this <a href="#scratch-bitmap">scratch bitmap</a>, if any. If the id member is null or no such region currently exists, let previous region for this ID be null.

7. If the arguments object's parent member is the empty string, let it be null instead.

8. If the arguments object's parent member is not null, then let parent region be <a href="#the-region-identified-by-the-id">the region identified by the ID</a> given by the parent member's value in the <a href="#scratch-bitmap">scratch bitmap</a>, if any. If the parent member is null or no such region currently exists, let parent region be null.

9. If the arguments object's label member is the empty string, let it be null instead.

10. If any of the following conditions are met, throw a NotSupportedError exception and abort these steps.

    • The arguments object's control and label members are both non-null.
    • The arguments object's control and role members are both non-null.
    • The arguments object's role member's value is the empty string, and the label member's value is either null or the empty string.
    • The specified pixels has no pixels.
    • The arguments object's control member is not null but is neither an a element that represents a hyperlink, a button element, an input element whose type attribute is in one of the Checkbox or Radio Button states, nor an input element that is a button.
    • The parent region is not null but has a <a data-anolis-xref="hit region's control" href="#hit-region%27s-control">control</a>.
    • The previous region for this ID is the same <a href="#hit-region">hit region</a> as the parent region.
    • The previous region for this ID is an <a href="#ancestor-region">ancestor region</a> of the parent region.

11. If the parent member is not null but parent region is null, then throw a NotFoundError exception and abort these steps.

12. If any of the following conditions are met, throw a SyntaxError exception and abort these steps.

    • The arguments object's cursor member is not null but is neither an ASCII case-insensitive match for the string "inherit", nor a valid CSS 'cursor' property value. <a href="#refsCSSUI">[CSSUI]</a>
    • The arguments object's role member is not null but its value is not an ordered set of unique space-separated tokens whose tokens are all case-sensitive matches for names of non-abstract WAI-ARIA roles. <a href="#refsARIA">[ARIA]</a>

13. Let region be a newly created <a href="#hit-region">hit region</a>, with its information configured as follows:

    <a href="#hit-region%27s-set-of-pixels">Hit region's set of pixels</a>

    The specified pixels

    <a href="#hit-region%27s-bounding-circumference">Hit region's bounding circumference</a>

    A user-agent-defined shape that wraps the pixels contained in source path. (In the simplest case, this can just be the bounding rectangle; this specification allows it to be any shape in order to allow other interfaces.)

    <a href="#hit-region%27s-id">Hit region's ID</a>

    If the arguments object's id member is not null: the value of the id member. Otherwise, region has no <a data-anolis-xref="hit region's id" href="#hit-region%27s-id">id</a>.

    <a href="#hit-region%27s-parent">Hit region's parent</a>

    If parent region is not null: parent region. Otherwise, region has no <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a>.

    <a href="#hit-region%27s-child-count">Hit region's child count</a>

    Initially zero.

    <a href="#hit-region%27s-cursor-specification">Hit region's cursor specification</a>

    If parent region is not null: parent region. Otherwise, region has no <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a>.

    <a href="#hit-region%27s-control">Hit region's control</a>

    If the arguments object's control member is not null: the value of the control member. Otherwise, region has no <a data-anolis-xref="hit region's control" href="#hit-region%27s-control">control</a>.

    <a href="#hit-region%27s-label">Hit region's label</a>

    If the arguments object's label member is not null: the value of the label member. Otherwise, region has no <a data-anolis-xref="hit region's label" href="#hit-region%27s-label">label</a>.

    <a href="#hit-region%27s-aria-role">Hit region's ARIA role</a>

    If the arguments object's role member is not null: the value of the role member (which might be the empty string). Otherwise, if the arguments object's label member is not null: the empty string. Otherwise, region has no <a data-anolis-xref="hit region's ARIA role" href="#hit-region%27s-aria-role">ARIA role</a>.

14. If the arguments object's cursor member is not null, then act as if a CSS rule for the canvas element setting its 'cursor' property had been seen, whose value was the <a href="#hit-region%27s-cursor-specification">hit region's cursor specification</a>.

    For example, if the user agent prefetches cursor values, this would cause that to happen in response to an appropriately-formed <a href="#dom-context-2d-addhitregion">addHitRegion()</a> call.

15. If the arguments object's control member is not null, then let previous region for the control be <a href="#the-region-representing-the-control">the region representing the control</a> given by the control member's value for this <a href="#scratch-bitmap">scratch bitmap</a>, if any. If the control member is null or no such region currently exists, let previous region for the control be null.

16. If there is a previous region with this control, remove it from the <a href="#scratch-bitmap">scratch bitmap</a>'s <a href="#hit-region-list">hit region list</a>; then, if it had a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> region, decrement that <a href="#hit-region%27s-child-count">hit region's child count</a> by one.

17. If there is a previous region with this ID, remove it, and all <a data-anolis-xref="hit region" href="#hit-region">hit regions</a> for which it is an <a href="#ancestor-region">ancestor region</a>, from the <a href="#scratch-bitmap">scratch bitmap</a>'s <a href="#hit-region-list">hit region list</a>; then, if it had a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> region, decrement that <a href="#hit-region%27s-child-count">hit region's child count</a> by one.

18. If there is a parent region, increment its <a href="#hit-region%27s-child-count">hit region's child count</a> by one.

19. <a href="#clear-regions-that-cover-the-pixels">Clear regions that cover the pixels</a> in region's <a data-anolis-xref="hit region's set of pixels" href="#hit-region%27s-set-of-pixels">set of pixels</a> on this <a href="#scratch-bitmap">scratch bitmap</a>.

20. Add region to the <a href="#scratch-bitmap">scratch bitmap</a>'s element's <a href="#hit-region-list">hit region list</a>.

When the removeHitRegion() method is invoked, the user agent must run the following steps:

1. Let region be <a href="#the-region-identified-by-the-id">the region identified by the ID</a> given by the method's argument in the rendering context's <a href="#scratch-bitmap">scratch bitmap</a>. If no such region currently exists, abort these steps.

   If the method's argument is the empty string, then no region will match.

2. Remove region, and all <a data-anolis-xref="hit region" href="#hit-region">hit regions</a> for which it is an <a href="#ancestor-region">ancestor region</a>, from the rendering context's <a href="#scratch-bitmap">scratch bitmap</a>'s <a href="#hit-region-list">hit region list</a>; then, if it had a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> region, decrement that <a href="#hit-region%27s-child-count">hit region's child count</a> by one.

3. <a href="#garbage-collect-the-regions">Garbage-collect the regions</a> of the rendering context's <a href="#scratch-bitmap">scratch bitmap</a>.

partial interface <span id="MouseEvent-partial">MouseEvent</span> {
  readonly attribute DOMString? <a data-anolis-xref="dom-MouseEvent-region" href="#dom-mouseevent-region">region</a>;
};

partial dictionary <span>MouseEventInit</span> {
  DOMString? region;
};

The region attribute on MouseEvent objects must return the value it was initialized to. When the object is created, this attribute must be initialized to null. It represents the <a href="#hit-region%27s-id">hit region's ID</a> if the mouse was over a hit region when the event was fired.

When a MouseEvent is to be fired at a canvas element by the user agent in response to a pointing device action, if the canvas element has a <a href="#hit-region-list">hit region list</a>, the user agent must instead follow these steps. If these steps say to act as normal, that means that the event must be fired as it would have had these requirements not been applied.

1. If the pointing device is not indicating a pixel on the canvas, act as normal and abort these steps.

2. Let pixel be the pixel indicated by the pointing device.

3. Let region be the <a href="#hit-region">hit region</a> that is <a data-anolis-xref="the region for a pixel" href="#the-region-for-a-pixel">the region for the pixel</a> pixel on this canvas element's bitmap, if any.

4. If there is no region, then act as normal and abort these steps.

5. Let id be the region's <a data-anolis-xref="hit region's ID" href="#hit-region%27s-id">ID</a>, if any.

6. If there is an id, then initialize the event object's <a href="#dom-mouseevent-region">region</a> attribute to id.

7. Let control be the <a data-anolis-xref="the control represented by a region" href="#the-control-represented-by-a-region">control represented by</a> region for this canvas element, if any.

8. If there is a control, then target the event object at control instead of the canvas element.

9. Continue dispatching the event, but with the updated event object and target as given in the above steps.

---

When a user's pointing device cursor is positioned over a canvas element, user agents should render the pointing device cursor according to the cursor specification described by <a data-anolis-xref="the cursor for a hit region" href="#the-cursor-for-a-hit-region">the cursor for the hit region</a> that is <a data-anolis-xref="the region for a pixel" href="#the-region-for-a-pixel">the region for the pixel</a> that the pointing device designates on the canvas element's bitmap.

---

User agents are encouraged to make use of the information present in a canvas element's <a href="#hit-region-list">hit region list</a> to improve the accessibility of canvas elements.

Each <a href="#hit-region">hit region</a> should be handled in a fashion equivalent to a node in a virtual DOM tree rooted at the canvas element. The hierarchy of this virtual DOM tree must match the hierarchy of the <a data-anolis-xref="hit region" href="#hit-region">hit regions</a>, as described by the <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> of each region. Regions without a <a data-anolis-xref="hit region's parent" href="#hit-region%27s-parent">parent</a> must be treated as children of the canvas element for the purpose of this virtual DOM tree. For each node in such a DOM tree, the <a href="#hit-region%27s-bounding-circumference">hit region's bounding circumference</a> gives the region of the screen to use when representing the node (if appropriate).

The semantics of a <a href="#hit-region">hit region</a> for the purposes of this virtual DOM tree are those of the <a data-anolis-xref="the control represented by a region" href="#the-control-represented-by-a-region">the control represented by the region</a>, if it has one, or else of a non-interactive element whose ARIA role, if any, is that given by the <a href="#hit-region%27s-aria-role">hit region's ARIA role</a>, and whose textual representation, if any, is given by the <a href="#hit-region%27s-label">hit region's label</a>.

For the purposes of accessibility tools, when an element C is a descendant of a canvas element and there is <a data-anolis-xref="the region representing the control" href="#the-region-representing-the-control">a region representing the control</a> C for that canvas element's bitmap, then the element's position relative to the document should be presented as if it was that region in the canvas element's virtual DOM tree.

The semantics of a <a href="#hit-region">hit region</a> for the purposes of this virtual DOM tree are those of the <a data-anolis-xref="the control represented by a region" href="#the-control-represented-by-a-region">the control represented by the region</a>, if it has one, or else of a non-interactive element whose ARIA role, if any, is that given by the <a href="#hit-region%27s-aria-role">hit region's ARIA role</a>, and whose textual representation, if any, is given by the <a href="#hit-region%27s-label">hit region's label</a>.

Thus, for instance, a user agent on a touch-screen device could provide haptic feedback when the user croses over a <a href="#hit-region%27s-bounding-circumference">hit region's bounding circumference</a>, and then read the <a href="#hit-region%27s-label">hit region's label</a> to the user. Similarly, a desktop user agent with a virtual accessibility focus separate from the keyboard input focus could allow the user to navigate through the hit regions, using the virtual DOM tree described above to enable hierarchical navigation. When an interactive control inside the canvas element is focused, if the control has a corresponding region, then that <a href="#hit-region%27s-bounding-circumference">hit region's bounding circumference</a> could be used to determine what area of the display to magnify.