@xeokit/xeokit-sdk 2.6.78-rc2-no-las → 2.6.78

package/types/viewer/scene/CameraControl/CameraControl.d.ts

@@ -118,7 +118,7 @@ export declare class CameraControl extends Component {
   on(event: "doublePickedNothing", callback: (e?: {canvasPos: number[]; }) => void, scope?: any): string
   
   /**
-   * The current navigation mode.
+   * Sets the current navigation mode.
    *
    * Accepted values are:
    *
@@ -127,77 +127,201 @@ export declare class CameraControl extends Component {
    * * "planView" - rotation is disabled.
    *
    * See class comments for more info.
+   *
+   * @param {String} navMode The navigation mode.
+   */
+  set navMode(arg: "orbit" | "firstPerson" | "planView");
+
+  /**
+   * Gets the current navigation mode.
+   *
+   * @returns {String} The navigation mode
+   */
+  get navMode(): "orbit" | "firstPerson" | "planView";
+
+  /**
+   * Sets whether to vertically constrain the {@link Camera} position for first-person navigation.
+   *
+   * When set ````true````, this constrains {@link Camera.eye} to its current vertical position.
+   *
+   * Only applies when {@link CameraControl.navMode} is ````"firstPerson"````.
+   *
+   * Default is ````false````.
+   *
+   * @param {Boolean} value Set ````true```` to vertically constrain the Camera.
    */
-  navMode: "orbit" | "firstPerson" | "planView";
+  set constrainVertical(arg: boolean);
 
   /**
-   * Whether to vertically constrain the {@link Camera} position for first-person navigation.
+   * Gets whether to vertically constrain the {@link Camera} position for first-person navigation.
    *
    * When set ````true````, this constrains {@link Camera.eye} to its current vertical position.
    *
    * Only applies when {@link CameraControl.navMode} is ````"firstPerson"````.
    *
    * Default is ````false````.
+   *
+   * @returns {Boolean} ````true```` when Camera is vertically constrained.
    */
-  constrainVertical: boolean;
+  get constrainVertical(): boolean;
 
   /**
-   * Custom mappings of keys to ````CameraControl```` actions.
+   * Sets custom mappings of keys to ````CameraControl```` actions.
    *
    * See class docs for usage.
+   *
+   * @param {{Number:Number}|String} value Either a set of new key mappings, or a string to select a keyboard layout,
+   * which causes ````CameraControl```` to use the default key mappings for that layout.
+   */
+  set keyMap(arg: {
+    [key: number]: number;
+  });
+
+  /**
+   * Gets custom mappings of keys to {@link CameraControl} actions.
+   *
+   * @returns {{Number:Number}} Current key mappings.
    */
-  keyMap: {
+  get keyMap(): {
     [key: number]: number;
   };
 
   /**
-   * Whether double-picking an {@link Entity} causes the {@link Camera} to fly to its boundary.
+   * Sets whether double-picking an {@link Entity} causes the {@link Camera} to fly to its boundary.
    *
    * Default is ````false````.
+   *
+   * @param {Boolean} value Set ````true```` to enable double-pick-fly-to mode.
+   */
+  set doublePickFlyTo(arg: boolean);
+
+  /**
+   * Gets whether double-picking an {@link Entity} causes the {@link Camera} to fly to its boundary.
+   *
+   * Default is ````false````.
+   *
+   * @returns {Boolean} Returns ````true```` when double-pick-fly-to mode is enabled.
+   */
+  get doublePickFlyTo(): boolean;
+
+  /**
+   * Sets whether either right-clicking (true) or middle-clicking (false) pans the {@link Camera}.
+   *
+   * Default is ````true````.
+   *
+   * @param {Boolean} value Set ````false```` to disable pan on right-click.
    */
-  doublePickFlyTo: boolean;
+  set panRightClick(arg: boolean);
 
   /**
-   * Whether either right-clicking (true) or middle-clicking (false) pans the {@link Camera}.
+   * Gets whether right-clicking pans the {@link Camera}.
    *
    * Default is ````true````.
+   *
+   * @returns {Boolean} Returns ````false```` when pan on right-click is disabled.
    */
-  panRightClick: boolean;
+  get panRightClick(): boolean;
 
   /**
-   * Whether this ````CameraControl```` is active or not.
+   *  Sets if this ````CameraControl```` is active or not.
    *
    * When inactive, the ````CameraControl```` will not react to input.
    *
    * Default is ````true````.
+   *
+   * @param {Boolean} value Set ````true```` to activate this ````CameraControl````.
+   */
+  set active(arg: boolean);
+
+  /**
+   * Gets if this ````CameraControl```` is active or not.
+   *
+   * When inactive, the ````CameraControl```` will not react to input.
+   *
+   * Default is ````true````.
+   *
+   * @returns {Boolean} Returns ````true```` if this ````CameraControl```` is active.
    */
-  active: boolean;
+  get active(): boolean;
 
   /**
-   * Whether the pointer snap to vertex.
+   * Sets whether the pointer snap to vertex.
+   *
+   * @param {boolean} arg
+   */
+  set snapToVertex(arg: boolean);
+
+  /**
+   * Gets whether the pointer snap to vertex.
+   *
+   * @returns {boolean}
    */
-  snapToVertex: boolean;
+  get snapToVertex(): boolean;
 
   /**
-   * Whether the pointer snap to edge.
+   * Sets whether the pointer snap to edge.
+   *
+   * @param {boolean} arg
    */
-  snapToEdge: boolean;
+  set snapToEdge(arg: boolean);
 
   /**
-   * The current snap radius for "hoverSnapOrSurface" events, to specify whether the radius
+   * Gets whether the pointer snap to edge.
+   *
+   * @returns {boolean}
+   */
+  get snapToEdge(): boolean;
+
+  /**
+   * Sets the current snap radius for "hoverSnapOrSurface" events, to specify whether the radius
    * within which the pointer snaps to the nearest vertex or the nearest edge.
    *
    * Default value is 30 pixels.
+   *
+   * @param {Number} arg The snap radius.
    */
-  snapRadius: number;
+  set snapRadius(arg: number);
 
   /**
-   * Whether the keyboard shortcuts are enabled ONLY if the mouse is over the canvas.
+   * Gets the current snap radius.
+   *
+   * @returns {Number} The snap radius.
    */
-  keyboardEnabledOnlyIfMouseover: boolean;
+  get snapRadius(): number;
 
   /**
-   * Whether the {@link Camera} follows the mouse/touch pointer.
+   * If `true`, the keyboard shortcuts are enabled ONLY if the mouse is over the canvas.
+   * 
+   * @param {boolean} arg
+   */
+  set keyboardEnabledOnlyIfMouseover(arg: boolean);
+
+  /**
+   * Gets whether the keyboard shortcuts are enabled ONLY if the mouse is over the canvas or ALWAYS.
+   * 
+   * @returns {boolean}
+   */
+  get keyboardEnabledOnlyIfMouseover(): boolean;
+
+  /**
+   * Sets whether the {@link Camera} follows the mouse/touch pointer.
+   *
+   * In orbiting mode, the Camera will orbit about the pointer, and will dolly to and from the pointer.
+   *
+   * In fly-to mode, the Camera will dolly to and from the pointer, however the World will always rotate about the Camera position.
+   *
+   * In plan-view mode, the Camera will dolly to and from the pointer, however the Camera will not rotate.
+   *
+   * Default is ````true````.
+   *
+   * See class comments for more info.
+   *
+   * @param {Boolean} value Set ````true```` to enable the Camera to follow the pointer.
+   */
+  set followPointer(arg: boolean);
+
+  /**
+   * Sets whether the {@link Camera} follows the mouse/touch pointer.
    *
    * In orbiting mode, the Camera will orbit about the pointer, and will dolly to and from the pointer.
    *
@@ -208,11 +332,13 @@ export declare class CameraControl extends Component {
    * Default is ````true````.
    *
    * See class comments for more info.
+   *
+   * @returns {Boolean} Returns ````true```` if the Camera follows the pointer.
    */
-  followPointer: boolean;
+  get followPointer(): boolean;
 
   /**
-   * A factor in range ````[0..1]```` indicating how much the {@link Camera} keeps moving after you finish rotating it.
+   * Sets a factor in range ````[0..1]```` indicating how much the {@link Camera} keeps moving after you finish rotating it.
    *
    * A value of ````0.0```` causes it to immediately stop, ````0.5```` causes its movement to decay 50% on each tick,
    * while ````1.0```` causes no decay, allowing it continue moving, by the current rate of rotation.
@@ -224,11 +350,24 @@ export declare class CameraControl extends Component {
    * Default is ````0.0````.
    *
    * Does not apply when {@link CameraControl.navMode} is ````"planView"````, which disallows rotation.
+   *
+   * @param {Number} rotationInertia New inertial factor.
    */
-  rotationInertia: number;
+  set rotationInertia(arg: number);
 
   /**
-   * How much the {@link Camera} pans each second with keyboard input.
+   * Gets the rotation inertia factor.
+   *
+   * Default is ````0.0````.
+   *
+   * Does not apply when {@link CameraControl.navMode} is ````"planView"````, which disallows rotation.
+   *
+   * @returns {Number} The inertia factor.
+   */
+  get rotationInertia(): number;
+
+  /**
+   * Sets how much the {@link Camera} pans each second with keyboard input.
    *
    * Default is ````5.0````, to pan the Camera ````5.0```` World-space units every second that
    * a panning key is depressed. See the ````CameraControl```` class documentation for which keys control
@@ -239,27 +378,58 @@ export declare class CameraControl extends Component {
    * and backwards, we pan along the direction the Camera is pointing.
    *
    * Unlike dollying when {@link followPointer} is ````true````, panning does not follow the pointer.
+   *
+   * @param {Number} keyboardPanRate The new keyboard pan rate.
    */
-  keyboardPanRate: number;
+  set keyboardPanRate(arg: number);
 
   /**
-   * How fast the {@link Camera} pans on touch panning
+   * Gets how much the {@link Camera} pans each second with keyboard input.
+   *
+   * Default is ````5.0````.
+   *
+   * @returns {Number} The current keyboard pan rate.
+   */
+  get keyboardPanRate(): number;
+
+  /**
+   * Sets how fast the camera pans on touch panning
+   *
+   * @param {Number} touchPanRate The new touch pan rate.
+   */
+  set touchPanRate(arg: number);
+
+  /**
+   * Gets how fast the {@link Camera} pans on touch panning
    *
    * Default is ````1.0````.
+   *
+   * @returns {Number} The current touch pan rate.
    */
-  touchPanRate: number;
+  get touchPanRate(): number;
 
   /**
-   * How many degrees per second the {@link Camera} rotates/orbits with keyboard input.
+   * Sets how many degrees per second the {@link Camera} rotates/orbits with keyboard input.
    *
    * Default is ````90.0````, to rotate/orbit the Camera ````90.0```` degrees every second that
    * a rotation key is depressed. See the ````CameraControl```` class documentation for which keys control
    * rotation/orbit.
+   *
+   * @param {Number} keyboardRotationRate The new keyboard rotation rate.
    */
-  keyboardRotationRate: number;
+  set keyboardRotationRate(arg: number);
 
   /**
-   * The current drag rotation rate.
+   * Sets how many degrees per second the {@link Camera} rotates/orbits with keyboard input.
+   *
+   * Default is ````90.0````.
+   *
+   * @returns {Number} The current keyboard rotation rate.
+   */
+  get keyboardRotationRate(): number;
+
+  /**
+   * Sets the current drag rotation rate.
    *
    * This configures how many degrees the {@link Camera} rotates/orbits for a full sweep of the canvas by mouse or touch dragging.
    *
@@ -271,18 +441,40 @@ export declare class CameraControl extends Component {
    * vertically when we sweep the entire height of the canvas.
    *
    * Default is ````360.0````.
+   *
+   * @param {Number} dragRotationRate The new drag rotation rate.
+   */
+  set dragRotationRate(arg: number);
+
+  /**
+   * Gets the current drag rotation rate.
+   *
+   * Default is ````360.0````.
+   *
+   * @returns {Number} The current drag rotation rate.
    */
-  dragRotationRate: number;
+  get dragRotationRate(): number;
 
   /**
-   * How much the {@link Camera} dollys each second with touch input.
+   * Sets how much the {@link Camera} dollys with touch input.
+   *
+   * Default is ````0.2````
+   *
+   * @param {Number} touchDollyRate The new touch dolly rate.
+   */
+  set touchDollyRate(arg: number);
+
+  /**
+   * Gets how much the {@link Camera} dollys each second with touch input.
    *
    * Default is ````0.2````.
+   *
+   * @returns {Number} The current touch dolly rate.
    */
-  touchDollyRate: number;
+  get touchDollyRate(): number;
 
   /**
-   * The dolly inertia factor.
+   * Sets the dolly inertia factor.
    *
    * This factor configures how much the {@link Camera} keeps moving after you finish dollying it.
    *
@@ -295,25 +487,58 @@ export declare class CameraControl extends Component {
    * which can improve rendering performance.
    *
    * Default is ````0````.
+   *
+   * @param {Number} dollyInertia New dolly inertia factor.
+   */
+  set dollyInertia(arg: number);
+
+  /**
+   * Gets the dolly inertia factor.
+   *
+   * Default is ````0````.
+   *
+   * @returns {Number} The current dolly inertia factor.
    */
-  dollyInertia: number;
+  get dollyInertia(): number;
 
   /**
-   * The proximity to the closest object below which dolly speed decreases, and above which dolly speed increases.
+   * Sets the proximity to the closest object below which dolly speed decreases, and above which dolly speed increases.
    *
    * Default is ````35.0````.
+   *
+   * @param {Number} dollyProximityThreshold New dolly proximity threshold.
+   */
+  set dollyProximityThreshold(arg: number);
+
+  /**
+   * Gets the proximity to the closest object below which dolly speed decreases, and above which dolly speed increases.
+   *
+   * Default is ````35.0````.
+   *
+   * @returns {Number} The current dolly proximity threshold.
+   */
+  get dollyProximityThreshold(): number;
+
+  /**
+   * Sets the minimum dolly speed.
+   *
+   * Default is ````0.04````.
+   *
+   * @param {Number} dollyMinSpeed New dolly minimum speed.
    */
-  dollyProximityThreshold: number;
+  set dollyMinSpeed(arg: number);
 
   /**
-   * The minimum dolly speed.
+   * Gets the minimum dolly speed.
    *
    * Default is ````0.04````.
+   *
+   * @returns {Number} The current minimum dolly speed.
    */
-  dollyMinSpeed: number;
+  get dollyMinSpeed(): number;
 
   /**
-   * The pan inertia factor.
+   * Sets the pan inertia factor.
    *
    * This factor configures how much the {@link Camera} keeps moving after you finish panning it.
    *
@@ -326,11 +551,35 @@ export declare class CameraControl extends Component {
    * wich can improve rendering performance.
    *
    * Default is ````0.5````.
+   *
+   * @param {Number} panInertia New pan inertia factor.
+   */
+  set panInertia(arg: number);
+
+  /**
+   * Gets the pan inertia factor.
+   *
+   * Default is ````0.5````.
+   *
+   * @returns {Number} The current pan inertia factor.
+   */
+  get panInertia(): number;
+
+  /**
+   * Sets the keyboard layout.
+   *
+   * Supported layouts are:
+   *
+   * * ````"qwerty"```` (default)
+   * * ````"azerty"````
+   *
+   * @deprecated
+   * @param {String} arg Selects the keyboard layout.
    */
-  panInertia: number;
+  set keyboardLayout(arg: string);
 
   /**
-   * The keyboard layout.
+   * Gets the keyboard layout.
    *
    * Supported layouts are:
    *
@@ -338,8 +587,9 @@ export declare class CameraControl extends Component {
    * * ````"azerty"````
    *
    * @deprecated
+   * @returns {String} The current keyboard layout.
    */
-  keyboardLayout: string;
+  get keyboardLayout(): string;
 
   /**
    * Sets a sphere as the representation of the pivot position.
@@ -357,14 +607,28 @@ export declare class CameraControl extends Component {
   disablePivotSphere(): void;
 
   /**
-   * Whether mouse and touch input is enabled.
+   * Sets whether mouse and touch input is enabled.
    *
    * Default is ````true````.
    *
    * Disabling mouse and touch input on ````CameraControl```` is useful when we want to temporarily use mouse or
    * touch input to interact with some other 3D control, without disturbing the {@link Camera}.
+   *
+   * @param {Boolean} value Set ````true```` to enable mouse and touch input.
+   */
+  set pointerEnabled(arg: boolean);
+
+  /**
+   * Gets whether mouse and touch input is enabled.
+   *
+   * Default is ````true````.
+   *
+   * Disabling mouse and touch input on ````CameraControl```` is desirable when we want to temporarily use mouse or
+   * touch input to interact with some other 3D control, without interfering with the {@link Camera}.
+   *
+   * @returns {Boolean} Returns ````true```` if mouse and touch input is enabled.
    */
-  pointerEnabled: boolean;
+  get pointerEnabled(): boolean;
 
   /**
    * Sets the cursor to be used when a particular action is being performed.
@@ -390,20 +654,42 @@ export declare class CameraControl extends Component {
   getCursorStyle(action: string): string | null;
 
   /**
-   * How much the {@link Camera} dollys each second with keyboard input.
+   * Sets how much the {@link Camera} dollys each second with keyboard input.
    *
    * Default is ````15.0````, to dolly the {@link Camera} ````15.0```` World-space units per second while we hold down
    * the ````+```` and ````-```` keys.
+   *
+   * @param {Number} keyboardDollyRate The new keyboard dolly rate.
+   */
+  set keyboardDollyRate(arg: number);
+
+  /**
+   * Gets how much the {@link Camera} dollys each second with keyboard input.
+   *
+   * Default is ````15.0````.
+   *
+   * @returns {Number} The current keyboard dolly rate.
    */
-  keyboardDollyRate: number;
+  get keyboardDollyRate(): number;
 
   /**
-   * How much the {@link Camera} dollys each second while the mouse wheel is spinning.
+   * Sets how much the {@link Camera} dollys each second while the mouse wheel is spinning.
    *
    * Default is ````100.0````, to dolly the {@link Camera} ````10.0```` World-space units per second as we spin
    * the mouse wheel.
+   *
+   * @param {Number} mouseWheelDollyRate The new mouse wheel dolly rate.
    */
-  mouseWheelDollyRate: number;
+  set mouseWheelDollyRate(arg: number);
+
+  /**
+   * Gets how much the {@link Camera} dollys each second while the mouse wheel is spinning.
+   *
+   * Default is ````100.0````.
+   *
+   * @returns {Number} The current mouseWheel dolly rate.
+   */
+  get mouseWheelDollyRate(): number;
 
   /**
    * Returns true if any keys configured for the given action are down.
@@ -414,31 +700,72 @@ export declare class CameraControl extends Component {
   private _isKeyDownForAction;
 
   /**
-   * The HTMl element to represent the pivot point when {@link CameraControl.followPointer} is true.
+   * Sets the HTMl element to represent the pivot point when {@link CameraControl.followPointer} is true.
    *
    * See class comments for an example.
+   *
+   * @param {HTMLElement} element HTML element representing the pivot point.
    */
-  pivotElement: HTMLElement;
+  set pivotElement(arg: HTMLElement);
 
   /**
-   * The current World-space 3D pivot position.
+   * Sets the current World-space 3D target position.
    *
    * Only applies when {@link CameraControl.followPointer} is ````true````.
+   *
+   * @param {Number[]} worldPos The new World-space 3D target position.
    */
-  pivotPos: number[];
+  set pivotPos(arg: number[]);
+
+  /**
+   * Gets the current World-space 3D pivot position.
+   *
+   * Only applies when {@link CameraControl.followPointer} is ````true````.
+   *
+   * @return {Number[]} worldPos The current World-space 3D pivot position.
+   */
+  get pivotPos(): number[];
+
+  /**
+   * @deprecated
+   * @param {Boolean} value Set ````true```` to enable dolly-to-pointer behaviour.
+   */
+  set dollyToPointer(arg: boolean);
+
+  /**
+   * @deprecated
+   * @returns {Boolean} Returns ````true```` if dolly-to-pointer behaviour is enabled.
+   */
+  get dollyToPointer(): boolean;
+
+  /**
+   * @deprecated
+   * @param {Boolean} value Set ````true```` to enable dolly-to-pointer behaviour.
+   */
+  set panToPointer(arg: boolean);
 
   /**
    * @deprecated
+   * @returns {Boolean} Returns ````true```` if dolly-to-pointer behaviour is enabled.
    */
-  dollyToPointer: boolean;
+  get panToPointer(): boolean;
 
   /**
+   * Sets whether this ````CameraControl```` is in plan-view mode.
+   *
+   * When in plan-view mode, rotation is disabled.
+   *
+   * Default is ````false````.
+   *
+   * Deprecated - use {@link CameraControl#navMode} instead.
+   *
+   * @param {Boolean} arg Set ````true```` to enable plan-view mode.
    * @deprecated
    */
-  panToPointer: boolean;
+  set planView(arg: boolean);
 
   /**
-   * Whether this ````CameraControl```` is in plan-view mode.
+   * Gets whether this ````CameraControl```` is in plan-view mode.
    *
    * When in plan-view mode, rotation is disabled.
    *
@@ -446,12 +773,13 @@ export declare class CameraControl extends Component {
    *
    * Deprecated - use {@link CameraControl#navMode} instead.
    *
+   * @returns {Boolean} Returns ````true```` if plan-view mode is enabled.
    * @deprecated
    */
-  planView: boolean;
+  get planView(): boolean;
 
   /**
-   * Whether this ````CameraControl```` is in first-person mode.
+   * Sets whether this ````CameraControl```` is in first-person mode.
    *
    * In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise,  {@link Camera.eye} rotates about {@link Camera.look}.
    *
@@ -459,12 +787,27 @@ export declare class CameraControl extends Component {
    *
    * Deprecated - use {@link CameraControl.navMode} instead.
    *
+   * @param {Boolean} value Set ````true```` to enable first-person mode.
    * @deprecated
    */
-  firstPerson: boolean;
+  set firstPerson(arg: boolean);
 
   /**
-   * Whether smart default pivoting is enabled.
+   * Gets whether this ````CameraControl```` is in first-person mode.
+   *
+   * In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise,  {@link Camera.eye} rotates about {@link Camera.look}.
+   *
+   * Default is ````false````.
+   *
+   * Deprecated - use {@link CameraControl.navMode} instead.
+   *
+   * @returns {Boolean} Returns ````true```` if first-person mode is enabled.
+   * @deprecated
+   */
+  get firstPerson(): boolean;
+
+  /**
+   * Sets whether smart default pivoting is enabled.
    *
    * When ````true````, we'll pivot by default about the 3D position of the mouse/touch pointer on an
    * imaginary sphere that's centered at {@link Camera.eye} and sized to the {@link Scene} boundary.
@@ -472,22 +815,58 @@ export declare class CameraControl extends Component {
    * When ````false````, we'll pivot by default about {@link Camera.look}.
    *
    * Default is ````false````.
+   *
+   * @param {Boolean} enabled Set ````true```` to pivot by default about the selected point on the virtual sphere, or ````false```` to pivot by default about {@link Camera.look}.
    */
-  smartPivot: boolean;
+  set smartPivot(arg: boolean);
 
   /**
-   * The double click time frame length in milliseconds.
+   * Gets whether smart default pivoting is enabled.
+   *
+   * When ````true````, we'll pivot by default about the 3D position of the mouse/touch pointer on an
+   * imaginary sphere that's centered at {@link Camera.eye} and sized to the {@link Scene} boundary.
+   *
+   * When ````false````, we'll pivot by default about {@link Camera.look}.
+   *
+   * Default is ````false````.
+   *
+   * @returns {Boolean} Returns ````true```` when pivoting by default about the selected point on the virtual sphere, or ````false```` when pivoting by default about {@link Camera.look}.
+   */
+  get smartPivot(): boolean;
+
+  /**
+   * Sets the double click time frame length in milliseconds.
    * 
    * If two mouse click events occur within this time frame, it is considered a double click. 
    * 
    * Default is ````250````
+   * 
+   * @param {Number} arg New double click time frame.
+   */
+  set doubleClickTimeFrame(arg: number);
+
+  /**
+   * Gets the double click time frame length in milliseconds.
+   *  
+   * Default is ````250````
+   * 
+   * @returns {Number} Current double click time frame.
    */
-  doubleClickTimeFrame: number;
+  get doubleClickTimeFrame(): number;
 
   /**
-   * Whether to zoom the camera on mouse wheel
+   * Sets whether to zoom the camera on mouse wheel
    *
    * Default is ````true````
+   *
+   * @param {Boolean} arg
+   */
+  set zoomOnMouseWheel(arg: boolean);
+
+  /**
+   * Gets whether to zoom the camera on mouse wheel
+   *
+   * @returns {Boolean}
    */
-  zoomOnMouseWheel: boolean;
+  get zoomOnMouseWheel(): boolean;
 }