D3.js - 缩放 API

缩放有助于缩放内容。您可以使用单击并拖动方法聚焦特定区域。在本章中,我们将详细讨论缩放 API。

配置 API

您可以使用以下脚本直接从"d3js.org"加载缩放 API。

<script src = "https://d3js.org/d3-color.v1.min.js"></script>
<script src = "https://d3js.org/d3-dispatch.v1.min.js"></script>
<script src = "https://d3js.org/d3-ease.v1.min.js"></script>
<script src = "https://d3js.org/d3-interpolate.v1.min.js"></script>
<script src = "https://d3js.org/d3-selection.v1.min.js"></script>
<script src = "https://d3js.org/d3-timer.v1.min.js"></script>
<script src = "https://d3js.org/d3-transition.v1.min.js"></script>
<script src = "https://d3js.org/d3-drag.v1.min.js"></script>
<script src = "https://d3js.org/d3-zoom.v1.min.js"></script>

<body>
   <script>
   </script>
</body>

缩放 API 方法

以下是一些最常用的缩放 API 方法。

  • d3.zoom()
  • zoom(selection)
  • zoom.transform(selection, transform)
  • zoom.translateBy(selection, x, y)
  • zoom.translateTo(selection, x, y)
  • zoom.scaleTo(selection, k)
  • zoom.scaleBy(selection, k)
  • zoom.filter([filter])
  • zoom.wheelDelta([delta])
  • zoom.extent([extent])
  • zoom.scaleExtent([extent])
  • zoom.translateExtent([extent])
  • zoom.clickDistance([distance])
  • zoom.duration([duration])
  • zoom.interpolate([interpolate])
  • zoom.on(typenames[, listener])

让我们简要介绍一下所有这些缩放 API 方法。

d3.zoom()

它创建了一个新的缩放行为。我们可以使用下面的脚本访问它。

<script>
var zoom = d3.zoom();
</script>

zoom(selection)

它用于对选定元素应用缩放转换。例如,您可以使用以下语法实例化 mousedown.zoom 行为。

selection.call(d3.zoom().on("mousedown.zoom", mousedowned));

zoom.transform(selection, transform)

用于将所选元素的当前缩放变换设置为指定的变换。例如,我们可以使用以下语法将缩放变换重置为身份变换。

selection.call(zoom.transform, d3.zoomIdentity);

我们还可以使用以下语法将缩放变换重置为身份变换 1000 毫秒。

selection.transition().duration(1000).call(zoom.transform, d3.zoomIdentity);

zoom.translateBy(selection, x, y)

用于将所选元素的当前缩放变换平移 x 和 y 值。您可以将 x 和 y 平移值指定为数字或返回数字的函数。如果为选定元素调用函数,则它会通过当前数据"d"和 DOM 索引"i"传递。示例代码定义如下。

zoom.translateBy(selection, x, y) {
   zoom.transform(selection, function() {
      return constrain(this.__zoom.translate(
         x = = = "function" ? x.apply(this, arguments) : x,
         y = = = "function" ? y.apply(this, arguments) : y
      );
   }
};

zoom.translateTo(selection, x, y)

它用于将所选元素的当前缩放变换平移到 x 和 y 的指定位置。

zoom.scaleTo(selection, k)

它用于将所选元素的当前缩放变换缩放到 k。此处,k 是比例因子,指定为数字或函数。

zoom.scaleTo = function(selection, k) {
   zoom.transform(selection, function() {
      k = = = "function" ? k.apply(this, arguments) : k;
   });
};

zoom.scaleBy(selection, k)

它用于按 k 缩放所选元素的当前缩放变换。此处,k 是缩放因子,可以指定为数字或返回数字的函数。

zoom.scaleBy = function(selection, k) {
   zoom.scaleTo(selection, function() {
      var k0 = this.__zoom.k,
      k1 = k = = = "function" ? k.apply(this, arguments) : k;
      return k0 * k1;
   });
};

zoom.filter([filter])

用于将过滤器设置为指定函数以实现缩放行为。如果未指定过滤器,则返回当前过滤器,如下所示。

function filter() {
    return !d3.event.button;
}

zoom.wheelDelta([delta])

Δ 的值由 wheel delta 函数返回。如果未指定 delta,则返回当前 wheel delta 函数。

zoom.extent([extent])

用于将范围设置为指定的数组点。如果没有指定范围,则返回当前范围访问器,默认为 [[0, 0], [width, height]],其中 width 是元素的客户端宽度,height 是其客户端高度。

zoom.scaleExtent([extent])

用于将缩放范围设置为指定的数字数组 [k0, k1]。其中,k0 是允许的最小缩放因子。而 k1 是允许的最大缩放因子。如果没有指定范围,则返回当前缩放范围,默认为 [0, ∞]。请考虑下面定义的示例代码。

selection
   .call(zoom)
   .on("wheel", function() { d3.event.preventDefault(); });

当已经达到比例范围的相应限制时,用户可以尝试通过旋转来缩放。如果我们想阻止在滚轮输入时滚动,而不管比例范围如何,请注册滚轮事件侦听器以防止浏览器默认行为。

zoom.translateExtent([extent])

如果指定了范围,它会将平移范围设置为指定的点数组。如果未指定范围,则返回当前平移范围,默认为 [[-∞, -∞], [+∞, +∞]]。

zoom.clickDistance([distance])

此方法用于设置可缩放区域上下移动的最大距离,这将触发后续的点击事件。

zoom.duration([duration])

此方法用于将双击和双击时的缩放过渡持续时间设置为指定的毫秒数,并返回缩放行为。如果未指定持续时间,则返回当前持续时间,默认为 250 毫秒,定义如下。

selection
    .call(zoom)
    .on("dblclick.zoom", null);

zoom.interpolate([interpolate])

此方法用于将缩放过渡插入到指定的函数。如果未指定 interpolate,则返回当前插值工厂,默认为 d3.interpolateZoom。

zoom.on(typenames[, listener])

如果指定了侦听器,则为指定的 typenames 设置事件侦听器并返回缩放行为。typenames 是一个字符串,包含一个或多个由空格分隔的 typename。每个 typename 都是一个类型,后面可以跟一个句点 (.) 和一个名称,例如 zoom.one 和 zoom.second。该名称允许为同一类型注册多个侦听器。此类型必须来自以下 − 之一

  • 开始 − 缩放开始后(例如鼠标按下时)。

  • 缩放 在缩放变换发生改变后(例如在鼠标移动时)减去 。

  • 缩放结束 在缩放结束后(例如在鼠标抬起时)减去 。

在下一章中,我们将讨论 D3.js 中的不同请求 API。