Provide a setter and getter method for map.interactive

[indus]

Motivation

At the moment the property "interactive" of map can only be set at the beginning and you can't turn it on and of during the lifetime of the map instance. I want to disable map interactivity during "flyto" activity to be sure that the map is at the correct spot at the "moveend" event. Userinterction during the flight would stop the animation and result in a "moveend" at a different location.

Design Alternatives

"Do nothing" is an option because it is possible to disable all Interaction-Handlers on "movestart" and re-enable them on "moveend" (but it is cumbersome to do, especially if you have to keep track of what was turned on before to come to the same setting afterwards). Could look like:

const MAP_HANDLER = ["boxZoom", "scrollZoom", "dragPan", ...];
function setInteractivity (val) {
  val = val ? 'enable' : 'disable';
  MAP_HANDLER.forEach((h) => (h = map[h]) && h.enable && h.disable && h[val]())
}

Design

Provide a method "setInteractivity(true/false)" (and a corresponding getter-method as well) to toggle the interactivity of the map. This value would be used to override the enabled/disabled state of all the handlers without changing it.

Mock-Up

for my case:

map.flyTo({ center: [0,0], zoom:0})
.once('movestart', ev => {
  map.setInteractivity(false)
  // drop all user interaction from here
})
.once('movend', ev => {
  //be dead certain to have the map centered at global scale
  map.setInteractivity(true);
  //map is interactive again
})

Concepts

What existing precedents support the new concepts?

other Map-Options have getter and setter methods as well

Implementation

How you would implement the design in Javascript?

All InteractionHandlers check for the global interactivity property on their corresponding map and drop events if it is set to false

[anandthakker]

Thanks @indus, I agree that it makes sense to have a getter/setter for this option.

[indus]

Sounds like #4029 will take care of it.

[bruno-vaz]

#4029 is still open as of today, is there a way to dynamically disable/enable all interactivity on the map?

[Erutan409]

@bruno-vaz I ended up creating an absolutely positioned div with a higher z-index on the map. If I wanted to disable interactivity, I'd just show the element. I connected it to an overloaded property on the map instance that when toggled (bit flag variable), it would use a defined setter to set the aforementioned element's visibility.