Camera

Defined in: packages/sigma/src/core/camera.ts:40

Camera class

Extends

• TypedEventEmitter<CameraEvents>

Implements

• CameraState

Constructors

Constructor

new Camera(): Camera

Defined in: packages/sigma/src/types.ts:254

Returns

Camera

Inherited from

TypedEventEmitter<CameraEvents>.constructor

Properties

enabled

enabled: boolean = true

Defined in: packages/sigma/src/core/camera.ts:44

---

enabledPanning

enabledPanning: boolean = true

Defined in: packages/sigma/src/core/camera.ts:46

---

enabledRotation

enabledRotation: boolean = true

Defined in: packages/sigma/src/core/camera.ts:47

---

enabledZooming

enabledZooming: boolean = true

Defined in: packages/sigma/src/core/camera.ts:45

---

maxRatio

maxRatio: number | null = null

Defined in: packages/sigma/src/core/camera.ts:42

---

minRatio

minRatio: number | null = null

Defined in: packages/sigma/src/core/camera.ts:41

---

rawEmitter

rawEmitter: EventEmitter

Defined in: packages/sigma/src/types.ts:232

Inherited from

TypedEventEmitter.rawEmitter

Accessors

angle

Get Signature

get angle(): number

Defined in: packages/sigma/src/core/camera.ts:72

Returns

number

Implementation of

CameraState.angle

---

ratio

Get Signature

get ratio(): number

Defined in: packages/sigma/src/core/camera.ts:75

Returns

number

Implementation of

CameraState.ratio

---

x

Get Signature

get x(): number

Defined in: packages/sigma/src/core/camera.ts:66

Returns

number

Implementation of

CameraState.x

---

y

Get Signature

get y(): number

Defined in: packages/sigma/src/core/camera.ts:69

Returns

number

Implementation of

CameraState.y

Methods

addListener()

addListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:238

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.addListener

---

animate()

animate(state, options?): Promise<void>

Defined in: packages/sigma/src/core/camera.ts:164

Animates the camera to the given state.

The returned promise resolves when the animation stops, whether it ran to completion or was interrupted by a new animation or by Camera#cancelAnimation. Read completed on the animationEnd event to tell those apart. On a disabled camera it resolves right away.

Parameters

state

Partial<CameraState>

options?

Partial<AnimateOptions>

Returns

Promise<void>

---

cancelAnimation()

cancelAnimation(): this

Defined in: packages/sigma/src/core/camera.ts:174

Stops the running animation where it is, leaving the camera at its current state. No-op when nothing is running.

Returns

this

---

emit()

emit<Event>(type, …args): boolean

Defined in: packages/sigma/src/types.ts:237

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

args

…Parameters<CameraEvents[Event]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

eventNames()

eventNames<Event>(): Event[]

Defined in: packages/sigma/src/types.ts:234

Type Parameters

Event

Event extends keyof CameraEvents

Returns

Event[]

Inherited from

TypedEventEmitter.eventNames

---

getBoundedRatio()

getBoundedRatio(ratio): number

Defined in: packages/sigma/src/core/camera.ts:104

Method used to check minRatio and maxRatio values.

Parameters

ratio

number

Returns

number

---

getMaxListeners()

getMaxListeners(): number

Defined in: packages/sigma/src/types.ts:236

Returns

number

Inherited from

TypedEventEmitter.getMaxListeners

---

getPreviousState()

getPreviousState(): CameraState

Defined in: packages/sigma/src/core/camera.ts:97

Method used to retrieve the state the camera had before its last update.

Returns

CameraState

---

getState()

getState(): CameraState

Defined in: packages/sigma/src/core/camera.ts:90

Method used to retrieve the camera’s current state.

Returns

CameraState

---

isAnimating()

isAnimating(): boolean

Defined in: packages/sigma/src/core/camera.ts:128

Method used to check whether an animation is currently running.

Returns

boolean

---

listenerCount()

listenerCount<Event>(type): number

Defined in: packages/sigma/src/types.ts:247

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

listeners()

listeners<Event>(type): CameraEvents[Event][]

Defined in: packages/sigma/src/types.ts:246

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

Returns

CameraEvents[Event][]

Inherited from

TypedEventEmitter.listeners

---

off()

off<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:244

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:239

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:240

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.once

---

prependListener()

prependListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:241

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependListener

---

prependOnceListener()

prependOnceListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:242

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependOnceListener

---

rawListeners()

rawListeners<Event>(type): CameraEvents[Event][]

Defined in: packages/sigma/src/types.ts:248

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

Returns

CameraEvents[Event][]

Inherited from

TypedEventEmitter.rawListeners

---

removeAllListeners()

removeAllListeners<Event>(type?): this

Defined in: packages/sigma/src/types.ts:245

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type?

Event

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

removeListener()

removeListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:243

Type Parameters

Event

Event extends keyof CameraEvents

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.removeListener

---

reset()

reset(options?): Promise<void>

Defined in: packages/sigma/src/core/camera.ts:203

Method used to animate the camera back to its default state.

Parameters

options?

Partial<AnimateOptions>

Returns

Promise<void>

---

setMaxListeners()

setMaxListeners(n): this

Defined in: packages/sigma/src/types.ts:235

Parameters

n

number

Returns

this

Inherited from

TypedEventEmitter.setMaxListeners

---

setState()

setState(state): this

Defined in: packages/sigma/src/core/camera.ts:135

Method used to set the camera’s state.

Parameters

state

Partial<CameraState>

Returns

this

---

updateState()

updateState(updater): this

Defined in: packages/sigma/src/core/camera.ts:151

Method used to update the camera’s state using a function.

Parameters

updater

(state) => Partial<CameraState>

Returns

this

---

validateState()

validateState(state): CameraState

Defined in: packages/sigma/src/core/camera.ts:115

Method used to merge a state candidate into the current state, dropping whatever the interaction flags forbid, and constraining the rest.

Parameters

state

Partial<CameraState>

Returns

CameraState

---

zoomIn()

zoomIn(__namedParameters?): Promise<void>

Defined in: packages/sigma/src/core/camera.ts:189

Method used to zoom the camera in, by dividing its ratio by factor.

Parameters

__namedParameters?

ZoomOptions = {}

Returns

Promise<void>

---

zoomOut()

zoomOut(__namedParameters?): Promise<void>

Defined in: packages/sigma/src/core/camera.ts:196

Method used to zoom the camera out, by multiplying its ratio by factor.

Parameters

__namedParameters?

ZoomOptions = {}

Returns

Promise<void>

---

from()

static from(state): Camera

Defined in: packages/sigma/src/core/camera.ts:82

Static method used to create a Camera object with a given state.

Parameters

state

CameraState

Returns

Camera