---
title: CanvasRenderingContext2D.addHitRegion()
slug: Web/API/CanvasRenderingContext2D/addHitRegion
translation_of: Web/API/CanvasRenderingContext2D/addHitRegion
---
<div>{{APIRef}} {{obsolete_header}}</div>

<p><code><strong>CanvasRenderingContext2D</strong></code><strong><code>.addHitRegion()</code></strong> 是 Canvas 2D API 给位图添加点击区域的方法。 它允许你很容易地实现一个点击区域， 让你触发 DOM 元素的事件， 去探索看不见的画布。</p>

<h2 id="语法">语法</h2>

<pre class="syntaxbox">void <var><em>ctx</em>.addHitRegion(<em>options</em>);</var>
</pre>

<h3 id="选项">选项</h3>

<p><code>options</code> 参数是可选的。 当赋值时， {{jsxref("Object")}} 包含以下属性：</p>

<dl>
 <dt><code>path</code></dt>
 <dd>{{domxref("Path2D")}} 对象， 描述点击区的区域范围。 如果不给此属性赋值， 则会使用当前的路径。</dd>
 <dt><code>fillRule</code></dt>
 <dd>遵循的填充规则（默认是“nonzero”）。</dd>
 <dt><code>id</code></dt>
 <dd>点击区的ID，在事件中可以引用此ID，就像示例中那样。</dd>
 <dt><code>parentID</code></dt>
 <dd>父区域的ID，为了光标回退或者辅助工具导航 。</dd>
 <dt><code>cursor</code></dt>
 <dd>鼠标移动到点击区时的 {{cssxref("cursor")}}  （默认是 "<code>inherit</code>"）。 继承父点击区域的光标，或者canvas元素的光标。</dd>
 <dt><code>control</code></dt>
 <dd>触发事件的元素（canvas的子孙元素）。 默认为 <code>null。</code></dd>
 <dt><code>label</code></dt>
 <dd>如果没有control属性，文本标签作为辅助工具，用作点击区域的描述。 默认为 <code>null。</code></dd>
 <dt><code>role</code></dt>
 <dd> 如果没有control属性，<a href="/en-US/docs/Web/Accessibility/ARIA">ARIA role</a> 作为辅助工具，决定如何表示点击区域。 默认为 <code>null</code>.</dd>
</dl>

<h2 id="示例">示例</h2>

<h3 id="使用_addHitRegion_方法">使用 <code>addHitRegion</code> 方法</h3>

<p>这是一段使用 <code>addHitRegion 方法的简单的代码片段。</code></p>

<h4 id="HTML">HTML</h4>

<pre class="brush: html">&lt;canvas id="canvas"&gt;&lt;/canvas&gt;
</pre>

<h4 id="JavaScript">JavaScript</h4>

<pre class="brush: js;">var canvas = document.getElementById("canvas");
var ctx = canvas.getContext("2d");

canvas.addEventListener("mousemove", function(event){
  if(event.region) {
    alert("ouch, my eye :(");
  }
});

ctx.beginPath();
ctx.arc(100, 100, 75, 0, 2 * Math.PI, false);
ctx.lineWidth = 5;
ctx.stroke();

// eyes
ctx.beginPath();
ctx.arc(70, 80, 10, 0, 2 * Math.PI, false);
ctx.arc(130, 80, 10, 0, 2 * Math.PI, false);
ctx.fill();
ctx.addHitRegion({id: "eyes"});

// mouth
ctx.beginPath();
ctx.arc(100, 110, 50, 0, Math.PI, false);
ctx.stroke();
</pre>

<p>修改下面的代码并在线查看canvas的变化（如果你没有看到全部的效果，请查看浏览器兼容性列表。如果你当前的浏览器支持点击区域，你需要激活偏好设置） 。</p>

<div class="hidden">
<h6 id="Playable_code">Playable code</h6>

<pre class="brush: html">&lt;canvas id="canvas" width="400" height="200" class="playable-canvas"&gt;&lt;/canvas&gt;
&lt;div class="playable-buttons"&gt;
  &lt;input id="edit" type="button" value="Edit" /&gt;
  &lt;input id="reset" type="button" value="Reset" /&gt;
&lt;/div&gt;
&lt;textarea id="code" class="playable-code" style="height:250px"&gt;
ctx.beginPath();
ctx.arc(100, 100, 75, 0, 2 * Math.PI, false);
ctx.lineWidth = 5;
ctx.stroke();

// eyes
ctx.beginPath();
ctx.arc(70, 80, 10, 0, 2 * Math.PI, false);
ctx.arc(130, 80, 10, 0, 2 * Math.PI, false);
ctx.fill();
ctx.addHitRegion({id: "eyes"});

// mouth
ctx.beginPath();
ctx.arc(100, 110, 50, 0, Math.PI, false);
ctx.stroke();&lt;/textarea&gt;
</pre>

<pre class="brush: js">var canvas = document.getElementById("canvas");
var ctx = canvas.getContext("2d");
var textarea = document.getElementById("code");
var reset = document.getElementById("reset");
var edit = document.getElementById("edit");
var code = textarea.value;

function drawCanvas() {
  ctx.clearRect(0, 0, canvas.width, canvas.height);
  eval(textarea.value);
}

reset.addEventListener("click", function() {
  textarea.value = code;
  drawCanvas();
});

edit.addEventListener("click", function() {
  textarea.focus();
});

canvas.addEventListener("mousemove", function(event){
  if(event.region) {
    alert("ouch, my eye :(");
  }
});

textarea.addEventListener("input", drawCanvas);
window.addEventListener("load", drawCanvas);
</pre>
</div>

<p>{{ EmbedLiveSample('Playable_code', 700, 520) }}</p>

<h2 id="规范描述">规范描述</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('HTML WHATWG', "scripting.html#dom-context-2d-addhitregion", "CanvasRenderingContext2D.addHitRegion")}}</td>
   <td>{{Spec2('HTML WHATWG')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>

<p>{{CompatibilityTable}}</p>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td><code>Basic support</code></td>
   <td>{{CompatVersionUnknown}}[1]</td>
   <td>{{CompatGeckoDesktop(30)}} [2]</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>id</code></td>
   <td>{{CompatVersionUnknown}}[1]</td>
   <td>{{CompatGeckoDesktop(30)}} [2]</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>control</code></td>
   <td>{{CompatVersionUnknown}}[1]</td>
   <td>{{CompatGeckoDesktop(30)}} [2]</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>path</code></td>
   <td>{{CompatVersionUnknown}}[1]</td>
   <td>{{CompatGeckoDesktop(39)}} [2]</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>fillRule</code></td>
   <td>{{CompatVersionUnknown}}[1]</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td>other hit region options</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Android</th>
   <th>Chrome for Android</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{CompatGeckoMobile(30)}}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>id</code></td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{CompatGeckoMobile(30)}}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>control</code></td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{CompatGeckoMobile(30)}}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>path</code></td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{CompatGeckoMobile(39)}}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td><code>fillRule</code></td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
  <tr>
   <td>other hit region options</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
   <td>{{ CompatNo }}</td>
  </tr>
 </tbody>
</table>
</div>

<h3 id="兼容性注解">兼容性注解</h3>

<ul>
 <li>[1] 此特性需要一个特性标志。 设置 <code>ExperimentalCanvasFeatures</code> 标志为 <code>true</code> 进行启用。</li>
 <li>[2] 此特性需要一个特性偏好设置。在 about:config里面，设置 <code>canvas.hitregions.enabled</code> 为true。</li>
</ul>

<h2 id="参见">参见</h2>

<ul>
 <li>{{domxref("CanvasRenderingContext2D.removeHitRegion()")}} {{experimental_inline}}</li>
 <li>{{domxref("CanvasRenderingContext2D.clearHitRegions()")}} {{experimental_inline}}</li>
</ul>