ZoomControl

Since version 4.0.0

source

Camera's zoom control

class ZoomControl extends Component<ZoomControlEvents> implements CameraControl

Extends

• Component<ZoomControlEvents>

Implements

• CameraControl

Properties

animating

Whether this control is animating the camera

duration

Duration of the input animation (ms)

easing

Easing function of the animation

enabled

Whether this control is enabled or not

scale

Scale factor of the zoom

scrollable

If true, enables scroll by mouse wheel on canvas.

caution

When this option is enabled, zoom by mouse wheel will be disabled.

zoom

Current zoom value

Methods

destroy

Destroy the instance and remove all event listeners attached.

disable

Disable this control and remove all event listeners

enable

Enable this control and add event listeners.

hasOn

off

on

once

sync

Synchronize this control's state to current camera state

trigger

Constructor

Create new ZoomControl instance

new ZoomControl(controlEl: HTMLElement, enableBlocked: boolean, options: Partial<ZoomControlOptions>): ZoomControl

Parameters

controlEl

HTMLElement

Element to attach handlers

enableBlocked

boolean

Whether to disable control on init

options

Partial<ZoomControlOptions>

{}

Options for control

Properties

animating

readonly

animating

boolean

Whether this control is animating the camera

source

duration

>=4.0.0

readonly

duration

number

300

Duration of the input animation (ms)

source

easing

>=4.0.0

readonly

easing

((x: number) => number)

EASING.EASE_OUT_CUBIC

Easing function of the animation

See

EASING

source

enabled

readonly

enabled

boolean

Whether this control is enabled or not

source

scale

>=4.0.0

scale

number

1

Scale factor of the zoom

source

scrollable

scrollable

boolean

If true, enables scroll by mouse wheel on canvas.

caution

When this option is enabled, zoom by mouse wheel will be disabled.

source

zoom

>=4.0.0

readonly

zoom

number

Current zoom value

source

Methods

destroy

>=4.0.0

destroy

void

destroy(): void

Destroy the instance and remove all event listeners attached.

source

disable

>=4.0.0

disable

void

disable(): void

Disable this control and remove all event listeners

source

enable

>=4.0.0

enable

void

enable(): void

Enable this control and add event listeners.

source

hasOn

inherited

hasOn

boolean

hasOn<K>(eventName: K): boolean

Parameters

eventName

K

off

inherited

off

ZoomControl

off<K>(eventName: K, handlerToDetach: EventCallback<ZoomControlEvents, K, ZoomControl>): ZoomControl

Parameters

eventName

K

handlerToDetach

EventCallback<ZoomControlEvents, K, ZoomControl>

on

inherited

on

ZoomControl

on(eventHash: Partial<{ change: ((event: { delta: number; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>): ZoomControl

Parameters

eventHash

Partial<{ change: ((event: { delta: number; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>

once

inherited

once

ZoomControl

once(eventHash: Partial<{ change: ((event: { delta: number; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>): ZoomControl

Parameters

eventHash

Partial<{ change: ((event: { delta: number; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>

sync

>=4.0.0

sync

void

sync(camera: Camera): void

Synchronize this control's state to current camera state

Parameters

camera

Camera

Camera's instance

source

trigger

inherited

trigger

ZoomControl

trigger<K>(event: K, ...params: EventTriggerParams<ZoomControlEvents, K>): ZoomControl

Parameters

event

K

params

EventTriggerParams<ZoomControlEvents, K>