Camera
Defined in: packages/sigma/src/core/camera.ts:40
Camera class
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Camera():
Camera
Defined in: packages/sigma/src/types.ts:275
Returns
Section titled “Returns”Camera
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”enabled
Section titled “enabled”enabled:
boolean=true
Defined in: packages/sigma/src/core/camera.ts:44
enabledPanning
Section titled “enabledPanning”enabledPanning:
boolean=true
Defined in: packages/sigma/src/core/camera.ts:46
enabledRotation
Section titled “enabledRotation”enabledRotation:
boolean=true
Defined in: packages/sigma/src/core/camera.ts:47
enabledZooming
Section titled “enabledZooming”enabledZooming:
boolean=true
Defined in: packages/sigma/src/core/camera.ts:45
maxRatio
Section titled “maxRatio”maxRatio:
number|null=null
Defined in: packages/sigma/src/core/camera.ts:42
minRatio
Section titled “minRatio”minRatio:
number|null=null
Defined in: packages/sigma/src/core/camera.ts:41
rawEmitter
Section titled “rawEmitter”rawEmitter:
EventEmitter
Defined in: packages/sigma/src/types.ts:253
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get angle():
number
Defined in: packages/sigma/src/core/camera.ts:72
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get ratio():
number
Defined in: packages/sigma/src/core/camera.ts:75
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get x():
number
Defined in: packages/sigma/src/core/camera.ts:66
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get y():
number
Defined in: packages/sigma/src/core/camera.ts:69
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:259
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”animate()
Section titled “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
Section titled “Parameters”Partial<CameraState>
options?
Section titled “options?”Partial<AnimateOptions>
Returns
Section titled “Returns”Promise<void>
cancelAnimation()
Section titled “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
Section titled “Returns”this
emit()
Section titled “emit()”emit<
Event>(type, …args):boolean
Defined in: packages/sigma/src/types.ts:258
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
…Parameters<CameraEvents[Event]>
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”eventNames()
Section titled “eventNames()”eventNames<
Event>():Event[]
Defined in: packages/sigma/src/types.ts:255
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Returns
Section titled “Returns”Event[]
Inherited from
Section titled “Inherited from”getBoundedRatio()
Section titled “getBoundedRatio()”getBoundedRatio(
ratio):number
Defined in: packages/sigma/src/core/camera.ts:104
Method used to check minRatio and maxRatio values.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Defined in: packages/sigma/src/types.ts:257
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”TypedEventEmitter.getMaxListeners
getPreviousState()
Section titled “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
Section titled “Returns”getState()
Section titled “getState()”getState():
CameraState
Defined in: packages/sigma/src/core/camera.ts:90
Method used to retrieve the camera’s current state.
Returns
Section titled “Returns”isAnimating()
Section titled “isAnimating()”isAnimating():
boolean
Defined in: packages/sigma/src/core/camera.ts:128
Method used to check whether an animation is currently running.
Returns
Section titled “Returns”boolean
listenerCount()
Section titled “listenerCount()”listenerCount<
Event>(type):number
Defined in: packages/sigma/src/types.ts:268
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”TypedEventEmitter.listenerCount
listeners()
Section titled “listeners()”listeners<
Event>(type):CameraEvents[Event][]
Defined in: packages/sigma/src/types.ts:267
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”CameraEvents[Event][]
Inherited from
Section titled “Inherited from”off<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:265
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”on<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:260
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:261
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependListener()
Section titled “prependListener()”prependListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:262
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TypedEventEmitter.prependListener
prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:263
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TypedEventEmitter.prependOnceListener
rawListeners()
Section titled “rawListeners()”rawListeners<
Event>(type):CameraEvents[Event][]
Defined in: packages/sigma/src/types.ts:269
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”CameraEvents[Event][]
Inherited from
Section titled “Inherited from”TypedEventEmitter.rawListeners
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners<
Event>(type?):this
Defined in: packages/sigma/src/types.ts:266
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TypedEventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:264
Type Parameters
Section titled “Type Parameters”Event extends keyof CameraEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”CameraEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TypedEventEmitter.removeListener
reset()
Section titled “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
Section titled “Parameters”options?
Section titled “options?”Partial<AnimateOptions>
Returns
Section titled “Returns”Promise<void>
setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
n):this
Defined in: packages/sigma/src/types.ts:256
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TypedEventEmitter.setMaxListeners
setState()
Section titled “setState()”setState(
state):this
Defined in: packages/sigma/src/core/camera.ts:135
Method used to set the camera’s state.
Parameters
Section titled “Parameters”Partial<CameraState>
Returns
Section titled “Returns”this
updateState()
Section titled “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
Section titled “Parameters”updater
Section titled “updater”(state) => Partial<CameraState>
Returns
Section titled “Returns”this
validateState()
Section titled “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
Section titled “Parameters”Partial<CameraState>
Returns
Section titled “Returns”zoomIn()
Section titled “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
Section titled “Parameters”__namedParameters?
Section titled “__namedParameters?”ZoomOptions = {}
Returns
Section titled “Returns”Promise<void>
zoomOut()
Section titled “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
Section titled “Parameters”__namedParameters?
Section titled “__namedParameters?”ZoomOptions = {}
Returns
Section titled “Returns”Promise<void>
from()
Section titled “from()”
staticfrom(state):Camera
Defined in: packages/sigma/src/core/camera.ts:82
Static method used to create a Camera object with a given state.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Camera