Sigma

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

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:246

Parameters

graph

AbstractGraph<N, E, G>

container

HTMLElement

options?

customEdgeState?

ForbidBaseKeys<BaseEdgeState, ES>

customGraphState?

ForbidBaseKeys<BaseGraphState, GS>

customNodeState?

ForbidBaseKeys<BaseNodeState, NS>

edgeReducer?

EdgeReducer<N, E, G, ES, GS>

nodeReducer?

NodeReducer<N, E, G, NS, GS>

primitives?

P

settings?

Partial<Settings>

styles?

StylesDeclaration<N, E, NoInfer<NS>, NoInfer<ES>, NoInfer<GS>, ExtractNodeVarsFromPrimitives<P>, ExtractEdgeVarsFromPrimitives<P>, ExtractDepthLayersFromPrimitives<P>>

Returns

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

Overrides

TypedEventEmitter<SigmaEvents>.constructor

Properties

rawEmitter

rawEmitter: EventEmitter

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

Inherited from

MouseCaptor.rawEmitter

Methods

_setPanning()

_setPanning(isPanning): void

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

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:2107

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

addCustomLayerProgram()

addCustomLayerProgram(id, depth, program): this

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

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.

Parameters

id

string

depth

ExtractDepthLayersFromPrimitives<P>

program

CustomLayerProgram

Returns

this

addListener()

addListener<Event>(type, listener): this

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

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:2301

Method used to clear all the canvases.

Returns

this

createCanvas()

createCanvas(id, options?): HTMLCanvasElement

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

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:1740

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:1790

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:237

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:234

Type Parameters

Event

Returns

Event[]

Inherited from

TypedEventEmitter.eventNames

framedGraphToViewport()

framedGraphToViewport(coordinates, override?): Coordinates

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

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

coordinates

Coordinates

override?

CoordinateConversionOverride = {}

Returns

Coordinates

getBBox()

getBBox(): object

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

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:1885

Method returning the renderer’s camera.

Returns

Camera

getContainer()

getContainer(): HTMLElement

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

Method returning the container DOM element.

Returns

HTMLElement

getCustomBBox()

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

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

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:1980

Method returning the current renderer’s dimensions.

Returns

Dimensions

getEdgeDisplayData()

getEdgeDisplayData(key): EdgeDisplayData | undefined

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

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:2178

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:2045

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:1917

Method returning the renderer’s graph.

Returns

AbstractGraph<N, E, G>

getGraphDimensions()

getGraphDimensions(): Dimensions

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

Method returning the current graph’s dimensions.

Returns

Dimensions

getGraphState()

getGraphState(): FullGraphState<GS>

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

Method returning the graph’s state.

Returns

FullGraphState<GS>

The graph’s state.

getGraphToViewportRatio()

getGraphToViewportRatio(): number

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

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:236

Returns

number

Inherited from

TypedEventEmitter.getMaxListeners

getMouseCaptor()

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

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

Method returning the mouse captor.

Returns

MouseCaptor<N, E, G>

getMouseLayer()

getMouseLayer(): HTMLElement

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

Returns the mouse interaction layer element.

Returns

HTMLElement

getNodeDisplayData()

getNodeDisplayData(key): NodeDisplayData | undefined

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

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:2169

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:2035

Method returning a node’s state.

Parameters

key

string

The node’s key.

Returns

FullNodeState<NS>

The node’s state.

getRenderParams()

getRenderParams(): RenderParams

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

Function used to get the render params.

Returns

RenderParams

getSetting()

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

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

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:2187

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:3046

Method that returns the stage canvas element.

Returns

HTMLCanvasElement

getStagePadding()

getStagePadding(): number

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

Function used to retrieve the actual stage padding value.

Returns

number

getTouchCaptor()

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

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

Method returning the touch captor.

Returns

TouchCaptor<N, E, G>

getViewportZoomedState()

getViewportZoomedState(viewportTarget, newRatio): CameraState

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

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:1843

Method returning the main WebGL context used by the renderer.

Returns

WebGL2RenderingContext

graphToViewport()

graphToViewport(coordinates, override?): Coordinates

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

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:2930

Method used to shut the container & release event listeners.

Returns

void

killLayer()

killLayer(id): this

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

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:247

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:246

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:244

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:239

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:240

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:241

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:242

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:248

Type Parameters

Event

Parameters

type

Event

Returns

SigmaEvents[Event][]

Inherited from

TypedEventEmitter.rawListeners

refresh()

refresh(opts?): this

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

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:245

Type Parameters

Event

Parameters

type?

Event

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

removeCustomLayerProgram()

removeCustomLayerProgram(id): this

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

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:243

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:2250

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:3036

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:2703

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:2685

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:1895

Method setting the renderer’s camera.

Parameters

camera

Camera

New camera.

Returns

this

setCustomBBox()

setCustomBBox(customBBox): this

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

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:2130

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:2077

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:1926

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:2088

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:235

Parameters

n

number

Returns

this

Inherited from

TypedEventEmitter.setMaxListeners

setNodesState()

setNodesState(keys, state): this

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

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:2065

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:2209

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:2236

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:2225

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:2801

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:2837

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.

Parameters

coordinates

Coordinates

override?

CoordinateConversionOverride = {}

Returns

Coordinates

viewRectangle()

viewRectangle(): object

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

Method returning the abstract rectangle containing the graph according to the camera’s state.

Returns

object

The view’s rectangle.

height

height: number

x1

x1: number

x2

x2: number

y1

y1: number

y2

y2: number