Settings

Defined in: packages/sigma/src/settings.ts:19

Sigma.js settings

Settings control camera, interaction, and rendering behavior. Styling is handled separately via the styles option. Program generation is handled via the primitives option.

Properties

allowInvalidContainer

allowInvalidContainer: boolean

Defined in: packages/sigma/src/settings.ts:85

---

antialiasEdges

antialiasEdges: boolean

Defined in: packages/sigma/src/settings.ts:36

---

antiAliasingFeather

antiAliasingFeather: number

Defined in: packages/sigma/src/settings.ts:35

---

antialiasNodes

antialiasNodes: boolean

Defined in: packages/sigma/src/settings.ts:37

---

autoRescale

autoRescale: boolean | "once"

Defined in: packages/sigma/src/settings.ts:54

---

autoRescaleContent

autoRescaleContent: AutoRescaleContent

Defined in: packages/sigma/src/settings.ts:55

---

cameraPanBoundaries

cameraPanBoundaries: true | AtLeastOne<{ boundaries: { x: [number, number]; y: [number, number]; }; tolerance: number; }> | null

Defined in: packages/sigma/src/settings.ts:75

---

DEBUG_displayPickingLayer

DEBUG_displayPickingLayer: boolean

Defined in: packages/sigma/src/settings.ts:88

---

DEBUG_gpuTimerQueries

DEBUG_gpuTimerQueries: boolean

Defined in: packages/sigma/src/settings.ts:91

---

DEBUG_logRenderStats

DEBUG_logRenderStats: boolean

Defined in: packages/sigma/src/settings.ts:90

---

DEBUG_logShaders

DEBUG_logShaders: boolean

Defined in: packages/sigma/src/settings.ts:89

---

doubleClickTimeout

doubleClickTimeout: number

Defined in: packages/sigma/src/settings.ts:46

---

doubleClickZoomingDuration

doubleClickZoomingDuration: number

Defined in: packages/sigma/src/settings.ts:48

---

doubleClickZoomingRatio

doubleClickZoomingRatio: number

Defined in: packages/sigma/src/settings.ts:47

---

draggedEventsTolerance

draggedEventsTolerance: number

Defined in: packages/sigma/src/settings.ts:41

---

dragPositionToAttributes

dragPositionToAttributes: ((position, node) => Record<string, unknown>) | null

Defined in: packages/sigma/src/settings.ts:60

---

dragTimeout

dragTimeout: number

Defined in: packages/sigma/src/settings.ts:40

---

edgeLabelAnchors

edgeLabelAnchors: "nodeLabels" | "allNodes"

Defined in: packages/sigma/src/settings.ts:25

---

edgeLabelEvents

edgeLabelEvents: LabelEventsSetting

Defined in: packages/sigma/src/settings.ts:28

---

edgePickingPadding

edgePickingPadding: number

Defined in: packages/sigma/src/settings.ts:31

---

enableCameraMouseRotation

enableCameraMouseRotation: boolean

Defined in: packages/sigma/src/settings.ts:74

---

enableCameraPanning

enableCameraPanning: boolean

Defined in: packages/sigma/src/settings.ts:72

---

enableCameraRotation

enableCameraRotation: boolean

Defined in: packages/sigma/src/settings.ts:73

---

enableCameraZooming

enableCameraZooming: boolean

Defined in: packages/sigma/src/settings.ts:71

---

enableEdgeEvents

enableEdgeEvents: boolean

Defined in: packages/sigma/src/settings.ts:26

---

enableNodeDrag

enableNodeDrag: boolean

Defined in: packages/sigma/src/settings.ts:58

---

gestureTarget

gestureTarget: "graph" | "shared" | "page"

Defined in: packages/sigma/src/settings.ts:79

---

getDraggedNodes

getDraggedNodes: (draggedNode) => string[]

Defined in: packages/sigma/src/settings.ts:59

Parameters

draggedNode

string

Returns

string[]

---

hideEdgesOnMove

hideEdgesOnMove: boolean

Defined in: packages/sigma/src/settings.ts:21

---

hideLabelsOnMove

hideLabelsOnMove: boolean

Defined in: packages/sigma/src/settings.ts:22

---

inertiaDuration

inertiaDuration: number

Defined in: packages/sigma/src/settings.ts:42

---

inertiaRatio

inertiaRatio: number

Defined in: packages/sigma/src/settings.ts:43

---

itemSizesReference

itemSizesReference: "screen" | "positions"

Defined in: packages/sigma/src/settings.ts:53

---

labelDensity

labelDensity: number

Defined in: packages/sigma/src/settings.ts:63

---

labelGridCellSize

labelGridCellSize: number

Defined in: packages/sigma/src/settings.ts:64

---

labelPickingPadding

labelPickingPadding: number

Defined in: packages/sigma/src/settings.ts:32

---

labelPixelSnapping

labelPixelSnapping: boolean

Defined in: packages/sigma/src/settings.ts:66

---

labelRenderedSizeThreshold

labelRenderedSizeThreshold: number

Defined in: packages/sigma/src/settings.ts:65

---

maxCameraRatio

maxCameraRatio: number | null

Defined in: packages/sigma/src/settings.ts:70

---

minCameraRatio

minCameraRatio: number | null

Defined in: packages/sigma/src/settings.ts:69

---

minEdgeThickness

minEdgeThickness: number

Defined in: packages/sigma/src/settings.ts:34

---

nodeLabelEvents

nodeLabelEvents: LabelEventsSetting

Defined in: packages/sigma/src/settings.ts:27

---

nodePickingPadding

nodePickingPadding: number

Defined in: packages/sigma/src/settings.ts:30

---

pickingDownSizingRatio

pickingDownSizingRatio: number

Defined in: packages/sigma/src/settings.ts:29

---

renderEdgeLabels

renderEdgeLabels: boolean

Defined in: packages/sigma/src/settings.ts:24

---

renderLabels

renderLabels: boolean

Defined in: packages/sigma/src/settings.ts:23

---

sharedGestureAppleWheelMessage

sharedGestureAppleWheelMessage: string

Defined in: packages/sigma/src/settings.ts:81

---

sharedGestureTouchMessage

sharedGestureTouchMessage: string

Defined in: packages/sigma/src/settings.ts:82

---

sharedGestureWheelMessage

sharedGestureWheelMessage: string

Defined in: packages/sigma/src/settings.ts:80

---

stagePadding

stagePadding: number

Defined in: packages/sigma/src/settings.ts:33

---

tapMoveTolerance

tapMoveTolerance: number

Defined in: packages/sigma/src/settings.ts:49

---

zoomDuration

zoomDuration: number

Defined in: packages/sigma/src/settings.ts:44

---

zoomingRatio

zoomingRatio: number

Defined in: packages/sigma/src/settings.ts:45

---

zoomToSizeRatioFunction

zoomToSizeRatioFunction: (ratio) => number

Defined in: packages/sigma/src/settings.ts:52

Parameters

ratio

number

Returns

number