Sigma

Defined in: packages/sigma/src/sigma.ts:150

Main class.

Param

Graph to render.

Param

DOM container in which to render.

Param

Optional settings.

Extends

TypedEventEmitter<SigmaEvents>

Type Parameters

N

N extends Attributes = Attributes

E

E extends Attributes = Attributes

G

G extends Attributes = Attributes

NS

NS = { }

ES

ES = { }

GS

GS = { }

P

P extends PrimitivesDeclaration = PrimitivesDeclaration

Constructors

Constructor

new Sigma<N, E, G, NS, ES, GS, P>(graph, container, options?): Sigma<N, E, G, NS, ES, GS, P>

Defined in: packages/sigma/src/sigma.ts:269

Parameters

graph

AbstractGraph<N, E, G>

container

HTMLElement

options?

SigmaOptions<N, E, G, NS, ES, GS, P> = {}

Returns

Sigma<N, E, G, NS, ES, GS, P>

Overrides

TypedEventEmitter.constructor

Properties

rawEmitter

rawEmitter: EventEmitter

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

Inherited from

TypedEventEmitter.rawEmitter

Methods

_hasNodeDrag()

_hasNodeDrag(): boolean

Defined in: packages/sigma/src/sigma.ts:2394

Internal: whether a node is being dragged.

Returns

boolean

_setPanning()

_setPanning(isPanning): void

Defined in: packages/sigma/src/sigma.ts:2378

Internal: toggle the graph-level isPanning flag. Called by captors when the user starts/stops dragging the stage. Not meant for user code, use setGraphState for custom flags instead.

Parameters

isPanning

boolean

Returns

void

_setZooming()

_setZooming(isZooming): void

Defined in: packages/sigma/src/sigma.ts:2387

Internal: toggle the graph-level isZooming flag. Called by captors for non-animated zoom gestures (e.g. pinch), which bypass camera.animate. Animated zooms are tracked automatically via camera events.

Parameters

isZooming

boolean

Returns

void

_showGestureHint()

_showGestureHint(gesture): void

Defined in: packages/sigma/src/sigma.ts:2403

Internal: display the shared-gestures hint. Called by captors when a plain gesture reaches the stage while gestureTarget is “shared”.

Parameters

gesture

"wheel" | "touch"

Returns

void

addCustomLayerProgram()

addCustomLayerProgram(id, depth, factory): this

Defined in: packages/sigma/src/sigma.ts:2131

Registers a custom layer program under a unique id, so it can later be removed with Sigma#removeCustomLayerProgram. It renders at the given depth, which must be declared in the primitives depthLayers array; several programs may share a depth and render in registration order. Reusing an id disposes the program previously registered under it. The factory is re-invoked when a lost WebGL context is restored.

Parameters

id

string

depth

ExtractDepthLayersFromPrimitives<P>

factory

CustomLayerProgramFactory

Returns

this

addListener()

addListener<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.addListener

clear()

clear(): this

Defined in: packages/sigma/src/sigma.ts:2633

Method used to clear all the canvases.

Returns

this

createCanvas()

createCanvas(id, options?): HTMLCanvasElement

Defined in: packages/sigma/src/sigma.ts:2033

Function used to create a canvas element.

Parameters

id

string

Context’s id.

options?

object & { beforeLayer?: string; } | { afterLayer?: string; } = {}

Returns

HTMLCanvasElement

createLayer()

createLayer<T>(id, tag, options?): T

Defined in: packages/sigma/src/sigma.ts:1994

Function used to create a layer element.

Type Parameters

T

T extends HTMLElement

Parameters

id

string

Context’s id.

tag

string

The HTML tag to use.

options?

object & { beforeLayer?: string; } | { afterLayer?: string; } = {}

Returns

T

createWebGLContext()

createWebGLContext(id, options?): WebGL2RenderingContext

Defined in: packages/sigma/src/sigma.ts:2044

Creates a new canvas layer registered under id (killable via killLayer) and attaches a WebGL 2 context to it.

Parameters

id

string

options?

object & { beforeLayer?: string; } | { afterLayer?: string; } = {}

Returns

WebGL2RenderingContext

emit()

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

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

Type Parameters

Event

Parameters

type

Event

args

…Parameters<SigmaEvents[Event]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

eventNames()

eventNames<Event>(): Event[]

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

Type Parameters

Event

Returns

Event[]

Inherited from

TypedEventEmitter.eventNames

framedGraphToGraph()

framedGraphToGraph(coordinates): Coordinates

Defined in: packages/sigma/src/sigma.ts:3218

Method used to translate a point’s coordinates from the framed graph system (the normalized ~[0, 1] space used by the camera state) to the graph system.

Parameters

coordinates

Coordinates

Returns

Coordinates

framedGraphToViewport()

framedGraphToViewport(coordinates, override?): Coordinates

Defined in: packages/sigma/src/sigma.ts:3123

Method returning the coordinates of a point from the framed graph system to the viewport system. It allows overriding anything that is used to get the translation matrix, or even the matrix itself.

Be careful if overriding dimensions, padding or cameraState, as the computation of the matrix is not the lightest of computations.

Parameters

getBBox()

getBBox(): object

Defined in: packages/sigma/src/sigma.ts:3268

Method returning the graph’s bounding box.

Returns

object

x

x: Extent

y

y: Extent

getCamera()

getCamera(): Camera

Defined in: packages/sigma/src/sigma.ts:2165

Method returning the renderer’s camera.

Returns

Camera

getContainer()

getContainer(): HTMLElement

Defined in: packages/sigma/src/sigma.ts:2189

Method returning the container DOM element.

Returns

HTMLElement

getCustomBBox()

getCustomBBox(): { x: Extent; y: Extent; } | null

Defined in: packages/sigma/src/sigma.ts:3277

Method returning the graph’s custom bounding box, if any.

Returns

{ x: Extent; y: Extent; } | null

getDimensions()

getDimensions(): Dimensions

Defined in: packages/sigma/src/sigma.ts:2260

Method returning the current renderer’s dimensions.

Returns

Dimensions

getEdgeDisplayData()

getEdgeDisplayData(key): EdgeDisplayData | undefined

Defined in: packages/sigma/src/sigma.ts:2298

Method used to get all the sigma edge attributes. It’s useful for example to get values that are set by the edgeReducer.

Parameters

key

string

The edge’s key.

Returns

EdgeDisplayData | undefined

A copy of the desired edge’s attribute or undefined if not found

getEdgeDisplayedLabels()

getEdgeDisplayedLabels(): Set<string>

Defined in: packages/sigma/src/sigma.ts:2478

Method used to get the set of currently displayed edge labels.

Returns

Set<string>

A set of edge keys whose label is displayed.

getEdgeState()

getEdgeState(key): FullEdgeState<ES>

Defined in: packages/sigma/src/sigma.ts:2325

Method returning an edge’s state.

Parameters

key

string

The edge’s key.

Returns

FullEdgeState<ES>

The edge’s state.

getGraph()

getGraph(): AbstractGraph<N, E, G>

Defined in: packages/sigma/src/sigma.ts:2198

Method returning the renderer’s graph.

Returns

AbstractGraph<N, E, G>

getGraphDimensions()

getGraphDimensions(): Dimensions

Defined in: packages/sigma/src/sigma.ts:2269

Method returning the current graph’s dimensions.

Returns

Dimensions

getGraphState()

getGraphState(): FullGraphState<GS>

Defined in: packages/sigma/src/sigma.ts:2334

Method returning the graph’s state.

Returns

FullGraphState<GS>

The graph’s state.

getGraphToViewportRatio()

getGraphToViewportRatio(): number

Defined in: packages/sigma/src/sigma.ts:3226

Method returning the distance multiplier between the graph system and the viewport system.

Returns

number

getMaxListeners()

getMaxListeners(): number

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

Returns

number

Inherited from

TypedEventEmitter.getMaxListeners

getMouseCaptor()

getMouseCaptor(): MouseCaptor<N, E, G>

Defined in: packages/sigma/src/sigma.ts:2242

Method returning the mouse captor.

Returns

MouseCaptor<N, E, G>

getMouseLayer()

getMouseLayer(): HTMLElement

Defined in: packages/sigma/src/sigma.ts:3424

Returns the mouse interaction layer element.

Returns

HTMLElement

getNodeDataTexture()

getNodeDataTexture(): NodeDataTexture

Defined in: packages/sigma/src/sigma.ts:2109

Returns the shared node data texture (position, size, shapeId per node). GPU-side position writers can use it to target their writes (see the “afterTexturesUpload” event). The texture object is recreated when its capacity grows, so consumers holding a WebGLTexture handle must re-read it every frame.

Returns

NodeDataTexture

getNodeDisplayData()

getNodeDisplayData(key): NodeDisplayData | undefined

Defined in: packages/sigma/src/sigma.ts:2286

Method used to get all the sigma node attributes. It’s useful for example to get the position of a node and to get values that are set by the nodeReducer

Parameters

key

string

The node’s key.

Returns

NodeDisplayData | undefined

A copy of the desired node’s attribute or undefined if not found

getNodeDisplayedLabels()

getNodeDisplayedLabels(): Set<string>

Defined in: packages/sigma/src/sigma.ts:2469

Method used to get the set of currently displayed node labels.

Returns

Set<string>

A set of node keys whose label is displayed.

getNodeState()

getNodeState(key): FullNodeState<NS>

Defined in: packages/sigma/src/sigma.ts:2315

Method returning a node’s state.

Parameters

key

string

The node’s key.

Returns

FullNodeState<NS>

The node’s state.

getNormalizationFunction()

getNormalizationFunction(): NormalizationFunction

Defined in: packages/sigma/src/sigma.ts:2119

Returns the current normalization function, mapping graph coordinates to the ~[0, 1] framed-graph space stored in the node data texture (and back, through its inverse method).

Returns

NormalizationFunction

getPrimitives()

getPrimitives(): PrimitivesDeclaration

Defined in: packages/sigma/src/sigma.ts:2525

Method returning a copy of the primitives declaration, as resolved at construction (i.e. with the defaults applied when none was given).

The copy is shallow: the rules it points to are the renderer’s own, and must be treated as read-only. Build new arrays and objects rather than mutating them in place.

Returns

PrimitivesDeclaration

A copy of the primitives declaration.

getRenderParams()

getRenderParams(): RenderParams

Defined in: packages/sigma/src/sigma.ts:1771

Function used to get the render params.

Returns

RenderParams

getSetting()

getSetting<K>(key): Settings[K]

Defined in: packages/sigma/src/sigma.ts:2497

Method returning the current value for a given setting key.

Type Parameters

K

K extends keyof Settings

Parameters

key

K

The setting key to get.

Returns

Settings[K]

The value attached to this setting key or undefined if not found

getSettings()

getSettings(): Settings

Defined in: packages/sigma/src/sigma.ts:2487

Method returning a copy of the settings collection.

Returns

Settings

A copy of the settings collection.

getStageCanvas()

getStageCanvas(): HTMLCanvasElement

Defined in: packages/sigma/src/sigma.ts:3417

Method that returns the stage canvas element.

Returns

HTMLCanvasElement

getStagePadding()

getStagePadding(): number

Defined in: packages/sigma/src/sigma.ts:1807

Function used to retrieve the actual stage padding value.

Returns

number

getStyles()

getStyles(): StylesDeclaration<N>

Defined in: packages/sigma/src/sigma.ts:2511

Method returning a copy of the styles declaration, as resolved at construction (i.e. with the defaults applied when none was given).

The copy is shallow: the rules it points to are the renderer’s own, and must be treated as read-only. Build new arrays and objects rather than mutating them in place.

Returns

StylesDeclaration<N>

A copy of the styles declaration.

getTouchCaptor()

getTouchCaptor(): TouchCaptor<N, E, G>

Defined in: packages/sigma/src/sigma.ts:2251

Method returning the touch captor.

Returns

TouchCaptor<N, E, G>

getViewportZoomedState()

getViewportZoomedState(viewportTarget, newRatio): CameraState

Defined in: packages/sigma/src/sigma.ts:3066

Method used to (un)zoom, while preserving the position of a viewport point. Used for instance to zoom “on the mouse cursor”.

Parameters

viewportTarget

Coordinates

newRatio

number

Returns

CameraState

getWebGLContext()

getWebGLContext(): WebGL2RenderingContext

Defined in: packages/sigma/src/sigma.ts:2097

Method returning the main WebGL context used by the renderer.

Returns

WebGL2RenderingContext

graphToFramedGraph()

graphToFramedGraph(coordinates): Coordinates

Defined in: packages/sigma/src/sigma.ts:3210

Method used to translate a point’s coordinates from the graph system to the framed graph system (the normalized ~[0, 1] space used by the camera state).

Parameters

coordinates

Coordinates

Returns

Coordinates

graphToViewport()

graphToViewport(coordinates, override?): Coordinates

Defined in: packages/sigma/src/sigma.ts:3202

Method used to translate a point’s coordinates from the graph system (the reference system of data as they are in the given graph instance) to the viewport system (pixel distance from the top-left of the stage).

This method accepts an optional camera which can be useful if you need to translate coordinates based on a different view than the one being currently being displayed on screen.

Parameters

coordinates

Coordinates

override?

CoordinateConversionOverride = {}

Returns

Coordinates

kill()

kill(): void

Defined in: packages/sigma/src/sigma.ts:3297

Method used to shut the container & release event listeners.

Returns

void

killLayer()

killLayer(id): this

Defined in: packages/sigma/src/sigma.ts:2080

Function used to properly kill a layer.

Parameters

id

string

Layer id.

Returns

this

listenerCount()

listenerCount<Event>(type): number

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

Type Parameters

Event

Parameters

type

Event

Returns

number

Inherited from

TypedEventEmitter.listenerCount

listeners()

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

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

Type Parameters

Event

Parameters

type

Event

Returns

SigmaEvents[Event][]

Inherited from

TypedEventEmitter.listeners

off()

off<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.off

on()

on<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.on

once()

once<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.once

prependListener()

prependListener<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependListener

prependOnceListener()

prependOnceListener<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependOnceListener

rawListeners()

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

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

Type Parameters

Event

Parameters

type

Event

Returns

SigmaEvents[Event][]

Inherited from

TypedEventEmitter.rawListeners

refresh()

refresh(opts?): this

Defined in: packages/sigma/src/sigma.ts:2953

Method used to refresh, i.e. force the renderer to reprocess graph data and render, but keep the state.

if a partialGraph is provided, we only reprocess those nodes & edges.
if schedule is TRUE, we schedule a render instead of sync render
if skipIndexation is TRUE, then labelGrid & program indexation are skipped (can be used if you haven’t modify x, y, zIndex & size)

Parameters

opts?

partialGraph?

{ edges?: string[]; nodes?: string[]; }

partialGraph.edges?

string[]

partialGraph.nodes?

string[]

schedule?

boolean

skipIndexation?

boolean

Returns

this

removeAllListeners()

removeAllListeners<Event>(type?): this

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

Type Parameters

Event

Parameters

type?

Event

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

removeCustomLayerProgram()

removeCustomLayerProgram(id): this

Defined in: packages/sigma/src/sigma.ts:2150

Removes (and disposes) the custom layer program registered under the given id.

Parameters

id

string

Returns

this

removeListener()

removeListener<Event>(type, listener): this

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

Type Parameters

Event

Parameters

type

Event

listener

SigmaEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.removeListener

resize()

resize(force?): this

Defined in: packages/sigma/src/sigma.ts:2578

Method used to resize the renderer.

Parameters

force?

boolean

If true, then resize is processed even if size is unchanged (optional).

Returns

this

scaleSize()

scaleSize(size?, cameraRatio?): number

Defined in: packages/sigma/src/sigma.ts:3407

Method used to scale the given size according to the camera’s ratio, i.e. zooming state.

Parameters

size?

number = 1

The size to scale (node size, edge thickness etc.).

cameraRatio?

number = ...

A camera ratio (defaults to the actual camera ratio).

Returns

number

The scaled size.

scheduleRefresh()

scheduleRefresh(opts?): this

Defined in: packages/sigma/src/sigma.ts:3054

Method used to schedule a refresh (i.e. fully reprocess graph data and render) at the next available frame. This method can be safely called on a same frame because it basically debounces refresh to the next frame.

Parameters

opts?

partialGraph?

{ edges?: string[]; nodes?: string[]; }

partialGraph.edges?

string[]

partialGraph.nodes?

string[]

skipIndexation?

boolean

Returns

this

scheduleRender()

scheduleRender(): this

Defined in: packages/sigma/src/sigma.ts:3036

Method used to schedule a render at the next available frame. This method can be safely called on a same frame because it basically debounces refresh to the next frame.

Returns

this

setCamera()

setCamera(camera): this

Defined in: packages/sigma/src/sigma.ts:2175

Method setting the renderer’s camera.

Parameters

camera

Camera

New camera.

Returns

this

setCustomBBox()

setCustomBBox(customBBox): this

Defined in: packages/sigma/src/sigma.ts:3286

Method used to override the graph’s bounding box with a custom one. Give null as the argument to stop overriding.

Parameters

customBBox

{ x: Extent; y: Extent; } | null

Returns

this

setEdgesState()

setEdgesState(keys, state): this

Defined in: packages/sigma/src/sigma.ts:2430

Method to update multiple edges’ states at once.

Parameters

keys

string[]

The edges’ keys.

state

Partial<BaseEdgeState> | Partial<FullEdgeState<ES>>

Partial state to merge.

Returns

this

setEdgeState()

setEdgeState(key, state): this

Defined in: packages/sigma/src/sigma.ts:2357

Method to update an edge’s state.

Parameters

key

string

The edge’s key.

state

Partial<BaseEdgeState> | Partial<FullEdgeState<ES>>

Partial state to merge.

Returns

this

setGraph()

setGraph(graph): this

Defined in: packages/sigma/src/sigma.ts:2207

Method used to set the renderer’s graph.

Parameters

graph

AbstractGraph<N, E, G>

Returns

this

setGraphState()

setGraphState(state): this

Defined in: packages/sigma/src/sigma.ts:2368

Method to update the graph’s state.

Parameters

state

Partial<BaseGraphState> | Partial<FullGraphState<GS>>

Partial state to merge.

Returns

this

setMaxListeners()

setMaxListeners(n): this

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

Parameters

n

number

Returns

this

Inherited from

TypedEventEmitter.setMaxListeners

setNodesState()

setNodesState(keys, state): this

Defined in: packages/sigma/src/sigma.ts:2418

Method to update multiple nodes’ states at once.

Parameters

keys

string[]

The nodes’ keys.

state

Partial<BaseNodeState> | Partial<FullNodeState<NS>>

Partial state to merge.

Returns

this

setNodeState()

setNodeState(key, state): this

Defined in: packages/sigma/src/sigma.ts:2345

Method to update a node’s state.

Parameters

key

string

The node’s key.

state

Partial<BaseNodeState> | Partial<FullNodeState<NS>>

Partial state to merge.

Returns

this

setSetting()

setSetting<K>(key, value): this

Defined in: packages/sigma/src/sigma.ts:2537

Method setting the value of a given setting key. Note that this will schedule a new render next frame.

Type Parameters

K

K extends keyof Settings

Parameters

key

K

The setting key to set.

value

Settings[K]

The value to set.

Returns

this

setSettings()

setSettings(settings): this

Defined in: packages/sigma/src/sigma.ts:2564

Method setting multiple settings at once.

Parameters

settings

Partial<Settings>

The settings to set.

Returns

this

updateSetting()

updateSetting<K>(key, updater): this

Defined in: packages/sigma/src/sigma.ts:2553

Method updating the value of a given setting key using the provided function. Note that this will schedule a new render next frame.

Type Parameters

K

K extends keyof Settings

Parameters

key

K

The setting key to set.

updater

(value) => Settings[K]

The update function.

Returns

this

viewportToFramedGraph()

viewportToFramedGraph(coordinates, override?): Coordinates

Defined in: packages/sigma/src/sigma.ts:3152

Method returning the coordinates of a point from the viewport system to the framed graph system. It allows overriding anything that is used to get the translation matrix, or even the matrix itself.

Be careful if overriding dimensions, padding or cameraState, as the computation of the matrix is not the lightest of computations.

Parameters

coordinates

Coordinates

override?

CoordinateConversionOverride = {}

Returns

Coordinates

viewportToGraph()

viewportToGraph(coordinates, override?): Coordinates

Defined in: packages/sigma/src/sigma.ts:3188

Method used to translate a point’s coordinates from the viewport system (pixel distance from the top-left of the stage) to the graph system (the reference system of data as they are in the given graph instance).

This method accepts an optional camera which can be useful if you need to translate coordinates based on a different view than the one being currently being displayed on screen.