Class: Camera

Defined in: sigma/src/core/camera.ts:26

Camera class

Extends

• TypedEventEmitter<CameraEvents>

Implements

• CameraState

Constructors

new Camera()

new Camera(): Camera

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

Returns

Camera

Overrides

TypedEventEmitter<CameraEvents>.constructor

Properties

angle

angle: number = 0

Defined in: sigma/src/core/camera.ts:29

Implementation of

CameraState.angle

---

animationCallback()?

optional animationCallback: () => void

Defined in: sigma/src/core/camera.ts:43

Returns

void

---

clean

clean: null | (state) => CameraState = null

Defined in: sigma/src/core/camera.ts:37

---

enabledPanning

enabledPanning: boolean = true

Defined in: sigma/src/core/camera.ts:35

---

enabledRotation

enabledRotation: boolean = true

Defined in: sigma/src/core/camera.ts:36

---

enabledZooming

enabledZooming: boolean = true

Defined in: sigma/src/core/camera.ts:34

---

maxRatio

maxRatio: null | number = null

Defined in: sigma/src/core/camera.ts:33

---

minRatio

minRatio: null | number = null

Defined in: sigma/src/core/camera.ts:32

---

ratio

ratio: number = 1

Defined in: sigma/src/core/camera.ts:30

Implementation of

CameraState.ratio

---

rawEmitter

rawEmitter: EventEmitter

Defined in: sigma/src/types.ts:114

Inherited from

TypedEventEmitter.rawEmitter

---

x

x: number = 0.5

Defined in: sigma/src/core/camera.ts:27

Implementation of

CameraState.x

---

y

y: number = 0.5

Defined in: sigma/src/core/camera.ts:28

Implementation of

CameraState.y

Methods

addListener()

addListener<Event>(type, listener): this

Defined in: sigma/src/types.ts:120

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.addListener

---

animate()

Call Signature

animate(state, opts, callback): void

Defined in: sigma/src/core/camera.ts:173

Method used to animate the camera.

Parameters

state

Partial<CameraState>

opts

Partial<AnimateOptions>

callback

() => void

Returns

void

Call Signature

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

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

Method used to animate the camera.

Parameters

state

Partial<CameraState>

opts?

Partial<AnimateOptions>

Returns

Promise<void>

---

animatedReset()

animatedReset(options?): Promise<void>

Defined in: sigma/src/core/camera.ts:276

Method used to reset the camera.

Parameters

options?

Partial<AnimateOptions>

Returns

Promise<void>

---

animatedUnzoom()

animatedUnzoom(factorOrOptions?): Promise<void>

Defined in: sigma/src/core/camera.ts:260

Method used to unzoom the camera.

Parameters

factorOrOptions?

number | Partial<AnimateOptions> & object

Returns

Promise<void>

---

animatedZoom()

animatedZoom(factorOrOptions?): Promise<void>

Defined in: sigma/src/core/camera.ts:244

Method used to zoom the camera.

Parameters

factorOrOptions?

number | Partial<AnimateOptions> & object

Returns

Promise<void>

---

copy()

copy(): Camera

Defined in: sigma/src/core/camera.ts:291

Returns a new Camera instance, with the same state as the current camera.

Returns

Camera

---

disable()

disable(): this

Defined in: sigma/src/core/camera.ts:71

Method used to disable the camera.

Returns

this

---

emit()

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

Defined in: sigma/src/types.ts:119

Type Parameters

• Event extends "updated"

Parameters

type

Event

args

...Parameters<CameraEvents[Event]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

enable()

enable(): this

Defined in: sigma/src/core/camera.ts:63

Method used to enable the camera.

Returns

this

---

eventNames()

eventNames<Event>(): Event[]

Defined in: sigma/src/types.ts:116

Type Parameters

• Event extends "updated"

Returns

Event[]

Inherited from

TypedEventEmitter.eventNames

---

getBoundedRatio()

getBoundedRatio(ratio): number

Defined in: sigma/src/core/camera.ts:114

Method used to check minRatio and maxRatio values.

Parameters

ratio

number

Returns

number

---

getMaxListeners()

getMaxListeners(): number

Defined in: sigma/src/types.ts:118

Returns

number

Inherited from

TypedEventEmitter.getMaxListeners

---

getPreviousState()

getPreviousState(): null | CameraState

Defined in: sigma/src/core/camera.ts:98

Method used to retrieve the camera's previous state.

Returns

null | CameraState

---

getState()

getState(): CameraState

Defined in: sigma/src/core/camera.ts:79

Method used to retrieve the camera's current state.

Returns

CameraState

---

hasState()

hasState(state): boolean

Defined in: sigma/src/core/camera.ts:91

Method used to check whether the camera has the given state.

Parameters

state

CameraState

Returns

boolean

---

isAnimated()

isAnimated(): boolean

Defined in: sigma/src/core/camera.ts:137

Method used to check whether the camera is currently being animated.

Returns

boolean

---

listenerCount()

listenerCount<Event>(type): number

Defined in: sigma/src/types.ts:129

Type Parameters

• Event extends "updated"

Parameters

type

Event

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

listeners()

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

Defined in: sigma/src/types.ts:128

Type Parameters

• Event extends "updated"

Parameters

type

Event

Returns

CameraEvents[Event][]

Inherited from

TypedEventEmitter.listeners

---

off()

off<Event>(type, listener): this

Defined in: sigma/src/types.ts:126

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<Event>(type, listener): this

Defined in: sigma/src/types.ts:121

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<Event>(type, listener): this

Defined in: sigma/src/types.ts:122

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.once

---

prependListener()

prependListener<Event>(type, listener): this

Defined in: sigma/src/types.ts:123

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependListener

---

prependOnceListener()

prependOnceListener<Event>(type, listener): this

Defined in: sigma/src/types.ts:124

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependOnceListener

---

rawListeners()

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

Defined in: sigma/src/types.ts:130

Type Parameters

• Event extends "updated"

Parameters

type

Event

Returns

CameraEvents[Event][]

Inherited from

TypedEventEmitter.rawListeners

---

removeAllListeners()

removeAllListeners<Event>(type?): this

Defined in: sigma/src/types.ts:127

Type Parameters

• Event extends "updated"

Parameters

type?

Event

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

removeListener()

removeListener<Event>(type, listener): this

Defined in: sigma/src/types.ts:125

Type Parameters

• Event extends "updated"

Parameters

type

Event

listener

CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.removeListener

---

setMaxListeners()

setMaxListeners(n): this

Defined in: sigma/src/types.ts:117

Parameters

n

number

Returns

this

Inherited from

TypedEventEmitter.setMaxListeners

---

setState()

setState(state): this

Defined in: sigma/src/core/camera.ts:144

Method used to set the camera's state.

Parameters

state

Partial<CameraState>

Returns

this

---

updateState()

updateState(updater): this

Defined in: sigma/src/core/camera.ts:165

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

Parameters

updater

(state) => Partial<CameraState>

Returns

this

---

validateState()

validateState(state): Partial<CameraState>

Defined in: sigma/src/core/camera.ts:124

Method used to check various things to return a legit state candidate.

Parameters

state

Partial<CameraState>

Returns

Partial<CameraState>

---

from()

static from(state): Camera

Defined in: sigma/src/core/camera.ts:55

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

Parameters

state

CameraState

Returns

Camera