From 8fbb14937182a8c66c822fdc9baf06a4511d0e3d Mon Sep 17 00:00:00 2001 From: Eric Hippler <45562924+Hippl-Eric@users.noreply.github.com> Date: Fri, 26 Nov 2021 04:14:30 -0500 Subject: [PATCH] Update Renderer documentation to clarify tolerance option Canvas only (#7515) * update renderer doc to clarify tolerance option Canvas only * Revert "update renderer doc to clarify tolerance option Canvas only" This reverts commit 6d9e82fc20d2e5eb4c39ed1e8cbecf0e09dd58d6. * moved tolerance option from Render to Canvas * Refactor _clickTolerance Co-authored-by: johnd0e Co-authored-by: johnd0e --- src/layer/vector/Canvas.js | 9 +++++++++ src/layer/vector/Path.js | 3 ++- src/layer/vector/Renderer.js | 6 +----- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/src/layer/vector/Canvas.js b/src/layer/vector/Canvas.js index 2c5a3dfde..da16a33d3 100644 --- a/src/layer/vector/Canvas.js +++ b/src/layer/vector/Canvas.js @@ -38,6 +38,15 @@ import {Bounds} from '../../geometry/Bounds'; */ export var Canvas = Renderer.extend({ + + // @section + // @aka Canvas options + options: { + // @option tolerance: Number = 0 + // How much to extend the click tolerance around a path/object on the map. + tolerance: 0 + }, + getEvents: function () { var events = Renderer.prototype.getEvents.call(this); events.viewprereset = this._onViewPreReset; diff --git a/src/layer/vector/Path.js b/src/layer/vector/Path.js index 9d80273ea..494a420c3 100644 --- a/src/layer/vector/Path.js +++ b/src/layer/vector/Path.js @@ -142,6 +142,7 @@ export var Path = Layer.extend({ _clickTolerance: function () { // used when doing hit detection for Canvas layers - return (this.options.stroke ? this.options.weight / 2 : 0) + this._renderer.options.tolerance; + return (this.options.stroke ? this.options.weight / 2 : 0) + + (this._renderer.options.tolerance || 0); } }); diff --git a/src/layer/vector/Renderer.js b/src/layer/vector/Renderer.js index 424a179b8..d2e5e77dc 100644 --- a/src/layer/vector/Renderer.js +++ b/src/layer/vector/Renderer.js @@ -34,11 +34,7 @@ export var Renderer = Layer.extend({ // @option padding: Number = 0.1 // How much to extend the clip area around the map view (relative to its size) // e.g. 0.1 would be 10% of map view in each direction - padding: 0.1, - - // @option tolerance: Number = 0 - // How much to extend click tolerance round a path/object on the map - tolerance : 0 + padding: 0.1 }, initialize: function (options) {