Class ZoomPanHandler

Handle zoom and pan for intersection layers

Hierarchy

ZoomPanHandler

Constructors

constructor

new ZoomPanHandler(elm: HTMLElement, onRescale: RescaleFunction, options?: ZoomAndPanOptions): ZoomPanHandler
Constructor
Parameters
- elm: HTMLElement
- onRescale: RescaleFunction
- options: ZoomAndPanOptions = ...
  
  options
Returns ZoomPanHandler
- Defined in control/ZoomPanHandler.ts:35

Properties

_enableTranslateExtent

_enableTranslateExtent: boolean

_zFactor

_zFactor: number = 1

container

container: Selection<HTMLElement, unknown, null, undefined> = null

currentTransform

currentTransform: ZoomTransform

elm

elm: HTMLElement = null

onRescale

onRescale: RescaleFunction = null

options

options: ZoomAndPanOptions = null

scaleX

scaleX: ScaleLinear<number, number, never> = null

scaleY

scaleY: ScaleLinear<number, number, never> = null

translateBoundsX

translateBoundsX: [number, number] = ...

translateBoundsY

translateBoundsY: [number, number] = ...

xBounds

xBounds: [number, number] = ...

yBounds

yBounds: [number, number] = ...

zoom

zoom: ZoomBehavior<Element, unknown> = null

Accessors

enableTranslateExtent

get enableTranslateExtent(): boolean
Get if enable translate extent (pan limit)

Returns
true if enabled

Returns boolean
- Defined in control/ZoomPanHandler.ts:166
set enableTranslateExtent(enabled: boolean): void
Set enable translate extent (pan limit)
Parameters
- enabled: boolean
  
  If should be enabled
Returns void
- Defined in control/ZoomPanHandler.ts:174

height

get height(): number
Getter returning height of target

Returns
height

Returns number
- Defined in control/ZoomPanHandler.ts:76

isXInverted

get isXInverted(): boolean
Check if x is inverted (right to left is positive) from x bounds

Returns
true if inverted

Returns boolean
- Defined in control/ZoomPanHandler.ts:150

isYInverted

get isYInverted(): boolean
Check if y is inverted (bottom to top is positive) from y bounds

Returns
true if inverted

Returns boolean
- Defined in control/ZoomPanHandler.ts:158

viewportRatio

get viewportRatio(): number
Ratio between height and width

Returns
ratio

Returns number
- Defined in control/ZoomPanHandler.ts:104

width

get width(): number
Getter returning width of target

Returns
width

Returns number
- Defined in control/ZoomPanHandler.ts:68

xRatio

get xRatio(): number
x ratios screen to value ratio

Returns
ratio

Returns number
- Defined in control/ZoomPanHandler.ts:113

xSpan

get xSpan(): number
Getter which calculate span from x bounds

Returns
x span

Returns number
- Defined in control/ZoomPanHandler.ts:84

yRatio

get yRatio(): number
y scale screen to value ratio

Returns
ratio

Returns number
- Defined in control/ZoomPanHandler.ts:123

ySpan

get ySpan(): number
Calculate span from y bounds

Returns
y span

Returns number
- Defined in control/ZoomPanHandler.ts:94

zFactor

get zFactor(): number
Get z-factor

Returns
z-factor

Returns number
- Defined in control/ZoomPanHandler.ts:133
set zFactor(factor: number): void
Set z factor
Parameters
- factor: number
Returns void
- Defined in control/ZoomPanHandler.ts:141

Methods

adjustToSize

adjustToSize(width?: number | boolean, height?: number, force?: boolean): void
Adjust zoom due to changes in size of target
Parameters
- Optional width: number | boolean
- Optional height: number
- force: boolean = false
  
  force update even if size did not change
Returns void
- Defined in control/ZoomPanHandler.ts:349

applyTransform

applyTransform(transform: ZoomTransform): void
Update scale
Parameters
- transform: ZoomTransform
Returns void
- Defined in control/ZoomPanHandler.ts:261

calculateTransform

calculateTransform(dx0: number, dx1: number, dy: number): ZoomTransform
Calculate new transform

Returns
New transformation matrix
Parameters
- dx0: number
- dx1: number
- dy: number
Returns ZoomTransform
- Defined in control/ZoomPanHandler.ts:386

currentStateAsEvent

currentStateAsEvent(): OnRescaleEvent
Create an event object from current state

Returns OnRescaleEvent
- Defined in control/ZoomPanHandler.ts:209

init

init(): void
Initialized handler

Returns void
- Defined in control/ZoomPanHandler.ts:239

onZoom

onZoom(event: {
transform: ZoomTransform;
}): void
Handle zoom
Parameters
- event: {
  transform: ZoomTransform;
  }
  - transform: ZoomTransform
Returns void
- Defined in control/ZoomPanHandler.ts:248

recalculateZoomTransform

recalculateZoomTransform(): void
Recalcualate the transform

Returns void
- Defined in control/ZoomPanHandler.ts:405

rescale

rescale(): void
Update scale

Returns void
- Defined in control/ZoomPanHandler.ts:230

setBounds

setBounds(xBounds: [number, number], yBounds: [number, number]): void
Set bounds
Parameters
- xBounds: [number, number]
- yBounds: [number, number]
Returns void
- Defined in control/ZoomPanHandler.ts:328

setMaxZoomLevel

setMaxZoomLevel(zoomlevel: number): ZoomPanHandler
Parameters
- zoomlevel: number
Returns ZoomPanHandler
- Defined in control/ZoomPanHandler.ts:425

setMinZoomLevel

setMinZoomLevel(zoomlevel: number): ZoomPanHandler
Parameters
- zoomlevel: number
Returns ZoomPanHandler
- Defined in control/ZoomPanHandler.ts:431

setTranslateBounds

setTranslateBounds(xBounds: [number, number], yBounds: [number, number]): void
Set bounds
Parameters
- xBounds: [number, number]
- yBounds: [number, number]
Returns void
- Defined in control/ZoomPanHandler.ts:338

setViewport

setViewport(cx?: number, cy?: number, displ?: number, duration?: number): void
Set new viewport

Returns
a merge of filter and payload
Parameters
- Optional cx: number
  
  center X pos
- Optional cy: number
  
  center Y pos
- Optional displ: number
- Optional duration: number
  
  duration of transition
Returns void
- Defined in control/ZoomPanHandler.ts:292

setZoomLevelBoundary

setZoomLevelBoundary(zoomlevels: [number, number]): ZoomPanHandler
Parameters
- zoomlevels: [number, number]
Returns ZoomPanHandler
- Defined in control/ZoomPanHandler.ts:420

updateTranslateExtent

updateTranslateExtent(): void
Update translate extent (pan limits)

Returns void
- Defined in control/ZoomPanHandler.ts:183

Class ZoomPanHandler

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

elm: HTMLElement

onRescale: RescaleFunction

options: ZoomAndPanOptions = ...

Returns ZoomPanHandler

Properties

_enableTranslateExtent

_zFactor

container

currentTransform

elm

onRescale

options

scaleX

scaleY

translateBoundsX

translateBoundsY

xBounds

yBounds

zoom

Accessors

enableTranslateExtent

Returns

Returns boolean

Parameters

enabled: boolean

Returns void

height

Returns

Returns number

isXInverted

Returns

Returns boolean

isYInverted

Returns

Returns boolean

viewportRatio

Returns

Returns number

width

Returns

Returns number

xRatio

Returns

Returns number

xSpan

Returns

Returns number

yRatio

Returns

Returns number

ySpan

Returns

Returns number

zFactor

Returns

Returns number

Parameters

factor: number

Returns void

Methods

adjustToSize

Parameters

Optional width: number | boolean

Optional height: number

force: boolean = false

Returns void

applyTransform

Parameters

transform: ZoomTransform

Returns void

`Optional` width: number | boolean

`Optional` height: number

event: {
transform: ZoomTransform;
}

`Optional` cx: number

`Optional` cy: number

`Optional` displ: number

`Optional` duration: number