Skip to main content

Interface: Settings<N, E, G>

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

Sigma.js settings

Type Parameters​

• N extends Attributes = Attributes

• E extends Attributes = Attributes

• G extends Attributes = Attributes

Properties​

allowInvalidContainer​

allowInvalidContainer: boolean

Defined in: sigma/src/settings.ts:102

antiAliasingFeather​

antiAliasingFeather: number

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

autoCenter​

autoCenter: boolean

Defined in: sigma/src/settings.ts:78

autoRescale​

autoRescale: boolean

Defined in: sigma/src/settings.ts:77

cameraPanBoundaries​

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

Defined in: sigma/src/settings.ts:96

defaultDrawEdgeLabel​

defaultDrawEdgeLabel: EdgeLabelDrawingFunction<N, E, G>

Defined in: sigma/src/settings.ts:56

defaultDrawNodeHover​

defaultDrawNodeHover: NodeHoverDrawingFunction<N, E, G>

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

defaultDrawNodeLabel​

defaultDrawNodeLabel: NodeLabelDrawingFunction<N, E, G>

Defined in: sigma/src/settings.ts:57

defaultEdgeColor​

defaultEdgeColor: string

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

defaultEdgeType​

defaultEdgeType: string

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

defaultNodeColor​

defaultNodeColor: string

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

defaultNodeType​

defaultNodeType: string

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

doubleClickTimeout​

doubleClickTimeout: number

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

doubleClickZoomingDuration​

doubleClickZoomingDuration: number

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

doubleClickZoomingRatio​

doubleClickZoomingRatio: number

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

draggedEventsTolerance​

draggedEventsTolerance: number

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

dragTimeout​

dragTimeout: number

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

edgeLabelColor​

edgeLabelColor: { attribute: string; color: string; } | { attribute: undefined; color: string; }

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

edgeLabelFont​

edgeLabelFont: string

Defined in: sigma/src/settings.ts:51

edgeLabelSize​

edgeLabelSize: number

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

edgeLabelWeight​

edgeLabelWeight: string

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

edgeProgramClasses​

edgeProgramClasses: object

Defined in: sigma/src/settings.ts:107

Index Signature​

[type: string]: EdgeProgramType<N, E, G>

edgeReducer​

edgeReducer: null | (edge, data) => Partial<DisplayData>

Defined in: sigma/src/settings.ts:87

enableCameraPanning​

enableCameraPanning: boolean

Defined in: sigma/src/settings.ts:94

enableCameraRotation​

enableCameraRotation: boolean

Defined in: sigma/src/settings.ts:95

enableCameraZooming​

enableCameraZooming: boolean

Defined in: sigma/src/settings.ts:93

enableEdgeEvents​

enableEdgeEvents: boolean

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

hideEdgesOnMove​

hideEdgesOnMove: boolean

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

hideLabelsOnMove​

hideLabelsOnMove: boolean

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

inertiaDuration​

inertiaDuration: number

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

inertiaRatio​

inertiaRatio: number

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

itemSizesReference​

itemSizesReference: "screen" | "positions"

Defined in: sigma/src/settings.ts:76

labelColor​

labelColor: { attribute: string; color: string; } | { attribute: undefined; color: string; }

Defined in: sigma/src/settings.ts:50

labelDensity​

labelDensity: number

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

labelFont​

labelFont: string

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

labelGridCellSize​

labelGridCellSize: number

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

labelRenderedSizeThreshold​

labelRenderedSizeThreshold: number

Defined in: sigma/src/settings.ts:83

labelSize​

labelSize: number

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

labelWeight​

labelWeight: string

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

maxCameraRatio​

maxCameraRatio: null | number

Defined in: sigma/src/settings.ts:92

minCameraRatio​

minCameraRatio: null | number

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

minEdgeThickness​

minEdgeThickness: number

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

nodeHoverProgramClasses​

nodeHoverProgramClasses: object

Defined in: sigma/src/settings.ts:106

Index Signature​

[type: string]: NodeProgramType<N, E, G>

nodeProgramClasses​

nodeProgramClasses: object

Defined in: sigma/src/settings.ts:105

Index Signature​

[type: string]: NodeProgramType<N, E, G>

nodeReducer​

nodeReducer: null | (node, data) => Partial<NodeDisplayData>

Defined in: sigma/src/settings.ts:86

renderEdgeLabels​

renderEdgeLabels: boolean

Defined in: sigma/src/settings.ts:39

renderLabels​

renderLabels: boolean

Defined in: sigma/src/settings.ts:38

stagePadding​

stagePadding: number

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

tapMoveTolerance​

tapMoveTolerance: number

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

zIndex​

zIndex: boolean

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

zoomDuration​

zoomDuration: number

Defined in: sigma/src/settings.ts:67

zoomingRatio​

zoomingRatio: number

Defined in: sigma/src/settings.ts:68

zoomToSizeRatioFunction()​

zoomToSizeRatioFunction: (ratio) => number

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

Parameters​

ratio​

number

Returns​

number