Skip to content
sigma.js
Search
Ctrl
K
Cancel
v4.0.6
Docs
Examples
GitHub
12.2K
Select theme
Dark
Light
Auto
Menu
Get started
Quickstart
Load a dataset
Style the graph
Add interactivity
How-to guides
Styling nodes
Colors & sizes
Shapes
Fill layers
Backdrops
Styling edges
Paths & colors
Fill layers
Extremities
Parallel edges & self-loops
Styling labels
Styles & positioning
Attachments
Adding interactivity
Interactions & events
Hover and search highlight
Drag & drop
Camera & viewport
Adding layers
Map layers
WebGL layers
Custom HTML/SVG elements
Technical guides
Load graph data
Custom sizes
Export image
Performances
Integrate with a framework
Migrating from v3 to v4
Concepts
Styles and primitives
Lifecycle
Rendering
Depth and z-order
Coordinate systems
Node and edge sizes
Reference
Sigma API
Camera API
Settings
Events reference
Style properties
Style value types
Primitives schema
State flags
Browser bundle
Examples
All examples
API reference
@sigma/export-image
Type Aliases
Override
ToImageOptions
Variables
DEFAULT_TO_IMAGE_OPTIONS
Functions
downloadAsImage
downloadAsJPEG
downloadAsPNG
drawOnCanvas
toBlob
toFile
@sigma/layer-leaflet
Functions
default
graphToLatlng
latlngToGraph
@sigma/layer-maplibre
Functions
default
graphToLatlng
latlngToGraph
@sigma/layer-webgl
Classes
WebGLLayerProgram
Type Aliases
ColorLayerOptions
ColorLayerProgramType
ContoursOptions
HeatmapOptions
WebGLLayerDefinition
WebGLLayerProgramType
Variables
DEFAULT_COLOR_LAYER_OPTIONS
DEFAULT_CONTOURS_OPTIONS
DEFAULT_HEATMAP_OPTIONS
QUAD_VERTICES
Functions
bindWebGLLayer
createColorLayerProgram
createContoursProgram
createDensitySplatProgram
createHeatmapProgram
getColorFragmentShader
getContoursFragmentShader
@sigma/node-border
Interfaces
CreateNodeBorderProgramOptions
Type Aliases
BorderSizeMode
LayerBorderOptions
Variables
borderSchema
DEFAULT_BORDER_SIZE_MODE
DEFAULT_BORDERS
DEFAULT_COLOR
DEFAULT_CREATE_NODE_BORDER_OPTIONS
Functions
layerBorder
@sigma/node-image
Classes
TextureManager
Interfaces
CreateNodeImageProgramOptions
LayerImageOptions
Type Aliases
Atlas
DrawingMode
ImageType
TextureManagerOptions
Variables
DEFAULT_CREATE_NODE_IMAGE_OPTIONS
DEFAULT_LAYER_IMAGE_OPTIONS
DEFAULT_TEXTURE_MANAGER_OPTIONS
imageSchema
Functions
layerImage
loadImage
loadRasterImage
loadSVGImage
@sigma/node-piechart
Interfaces
CreateNodePiechartProgramOptions
Type Aliases
LayerPiechartOptions
Variables
DEFAULT_COLOR
DEFAULT_CREATE_NODE_PIECHART_OPTIONS
piechartSchema
Functions
layerPiechart
sigma
Classes
Camera
MouseCaptor
SDFAtlasManager
Sigma
TouchCaptor
Type Aliases
CameraAnimationEndPayload
CameraAnimationPayload
CameraEvents
ZoomOptions
Variables
DEFAULT_CAMERA_STATE
DEFAULT_DEPTH_LAYERS
DEFAULT_EDGE_DEPTH_LAYERS
DEFAULT_NODE_DEPTH_LAYERS
DEFAULT_STYLES
DEPTHLESS_STYLES
easings
References
default
Easing
sigma/rendering
Classes
AttachmentManager
DataTexture
DepthBucketCollection
EdgeDataTexture
EdgeFramePass
FrameTexture
GLStateGuard
LabelProgram
NodeDataTexture
NodeLabelFramePass
Program
Interfaces
ArrowExtremityOptions
AttachmentProgram
AttributeSpecification
BackdropDisplayData
BackdropProgram
BackdropShaderOptions
BarExtremityOptions
CircleExtremityOptions
CreateBackdropProgramOptions
CreateEdgeLabelBackgroundProgramOptions
CreateEdgeLabelProgramOptions
CreateLabelProgramOptions
CurvedPathOptions
CurvedSPathOptions
DiamondExtremityOptions
DiamondOptions
EdgeContextFields
EdgeExtremity
EdgeFramePassOptions
EdgeLabelBackgroundData
EdgeLabelBackgroundProgram
EdgeLabelOptions
EdgeLabelProgram
EdgeLabelShaderOptions
EdgeLayer
EdgeLifecycleContext
EdgeLifecycleHooks
EdgePath
EdgeProgram
EdgeProgramBundle
EdgeProgramOptions
FragmentLayer
FrameTextureOptions
GeneratedBackdropShaders
GeneratedEdgeLabelShaders
GeneratedEdgeShaders
GeneratedLabelShaders
GeneratedShaders
InstancedProgramDefinition
LabelBackgroundData
LabelBackgroundProgram
LabelFontOptions
LabelOptions
LayerContext
LayerDashedOptions
LayerFillOptions
LayerGradientOptions
LayerLifecycleContext
LayerLifecycleHooks
LayerPlainOptions
LoopPathOptions
NodeLabelFramePassOptions
NodeProgram
NodeProgramBundle
NodeProgramOptions
ProgramAttributeSpecification
ProgramDefinition
ProgramInfo
RectangleOptions
ResolvedEdgeColor
ResolvedEdgeIds
SDFShape
ShaderGenerationOptions
SquareExtremityOptions
SquareOptions
StepCurvedPathOptions
StepPathOptions
TriangleOptions
Type Aliases
DashCap
DashSize
DashSizeMode
EdgeColorValue
EdgeLabelColorSpecification
EdgeShaderGenerationOptions
GapFilling
GradientStop
Mat3
Mat4
ProgramType
SolidExtremities
SolidMargin
UniformSpecification
ValueSource
Vec2
Vec3
Vec4
Variables
DEFAULT_LABEL_BACKGROUND_PADDING
DEFAULT_LABEL_MARGIN
GLSL_GET_LABEL_DIRECTION
GLSL_LABEL_BOX_CENTER
GLSL_NODE_SIZE_TO_PIXELS
GLSL_READ_FRAME_TEXEL
GLSL_READ_NODE_COLOR
GLSL_READ_NODE_DATA
GLSL_READ_NODE_FLAGS
GLSL_ROTATE_2D
GLSL_SDF_BOX
GLSL_SDF_ROTATED_BOX
GLSL_SDF_ROUNDED_BOX
GLSL_SDF_ROUNDED_ROTATED_BOX
NODE_DATA_TEXELS_PER_NODE
POSITION_MODE_MAP
Functions
clearShapeInstanceRegistry
collectAttributes
collectBackdropUniforms
collectLabelUniforms
collectUniforms
createBackdropProgram
createEdgeLabelBackgroundProgram
createEdgeLabelProgram
createEdgeProgram
createLabelProgram
createNodeProgram
dedupeShapeUniforms
extremityArrow
extremityBar
extremityCircle
extremityDiamond
extremitySquare
generateBackdropFragmentShader
generateBackdropShaders
generateBackdropVertexShader
generateEdgeLabelShaders
generateEdgeShaders
generateFindEdgeDistanceForShapes
generateFragmentShader
generateLabelFragmentShader
generateLabelShaders
generateLabelVertexShader
generateNodeShapeSelectorGLSL
generateSDFCall
generateShaders
generateShapeSelectorGLSL
generateVertexShader
getAllShapeGLSL
getAttributesItemsCount
getRegisteredShapeInstance
getRegisteredShapeSlugs
getShapeFromSlug
getShapeGLSL
getShapeGLSLForShapes
getShapeId
getStaticAttributeDefault
isAttributeSource
killProgram
layerDashed
layerFill
layerGradient
layerPlain
loadFragmentShader
loadProgram
loadVertexShader
numberToGLSLFloat
pathCurved
pathCurvedS
pathLine
pathLoop
pathStep
pathStepCurved
registerShapeInstance
resolveEdgeColorValue
sdfCircle
sdfDiamond
sdfRectangle
sdfSquare
sdfTriangle
sigma/settings
Interfaces
Settings
Variables
DEFAULT_SETTINGS
Functions
resolveSettings
validateSettings
sigma/src/primitives
Interfaces
ArrayPropertyOptions
ArrayPropertySchema
BackdropOptions
CustomEdgeExtremity
CustomEdgeLayer
CustomEdgePath
CustomNodeLayer
CustomNodeShape
EdgePrimitives
EnumPropertyType
GraphicVariableDefinition
LabelAttachmentContext
NodePrimitives
ParsedEdgePrimitives
ParsedNodePrimitives
PrimitivesDeclaration
PropertyOptionsNoVariable
PropertyOptionsWithVariable
PropertySchema
Type Aliases
BuiltInVariableNames
DefaultDepthLayer
DefaultEdgeDepthLayer
DefaultNodeDepthLayer
EdgeBuiltInVariableNames
EdgeExtremitySpec
EdgeLayerSpec
EdgePathSpec
EmptySchema
ExtractAllEdgeVariables
ExtractAllNodeVariables
ExtractDepthLayersFromPrimitives
ExtractEdgeVarsFromPrimitives
ExtractNodeVarsFromPrimitives
FactoryOptionFromProperty
FactoryOptionsFromItemSchema
FactoryOptionsFromSchema
GeneratedEdgeProgram
GeneratedNodeProgram
GraphicVariableType
IsCustomVariable
LabelAttachmentContent
LabelAttachmentRenderer
NodeBuiltInVariableNames
NodeLayerSpec
NodeShapeSpec
PrimitivePropertyType
PrimitiveSchema
PropertyType
ResolvedOptionsFromItemSchema
ResolvedOptionsFromSchema
TypeFromPropertySchema
TypeFromPropertyType
UnionToIntersection
VariablesDefinition
Variables
DEFAULT_DEPTH_LAYERS
DEFAULT_EDGE_DEPTH_LAYERS
DEFAULT_EDGE_PRIMITIVES
DEFAULT_NODE_DEPTH_LAYERS
DEFAULT_NODE_PRIMITIVES
DEFAULT_PRIMITIVES
Functions
arrayProp
booleanProp
colorProp
enumProp
generateEdgeProgram
generateNodeProgram
isArrayPropertySchema
isCustomEdgeLayer
isCustomNodeLayer
numberProp
parseEdgeExtremity
parseEdgeLayer
parseEdgePath
parseEdgePrimitives
parseNodeLayer
parseNodePrimitives
parseNodeShape
stringProp
sigma/src/types
Classes
TypedEventEmitter
Interfaces
BaseEdgeState
BaseGraphState
BaseNodeState
CameraState
Coordinates
Dimensions
DirectAttributeBinding
DisplayData
EdgeDisplayData
EdgeLabelDisplayData
FontDescriptor
GlyphMetrics
InlineDataConditional
InlineFunctionConditional
InlineStateConditional
LabelDisplayData
MouseCoords
NodeBackdropBuiltInVariables
NodeDisplayData
NumericalAttributeBinding
RenderParams
ResolvedStageStyle
SDFAtlasOptions
SigmaEdgeEventPayload
SigmaEdgeLabelEventPayload
SigmaEventPayload
SigmaNodeDragEventPayload
SigmaNodeDragMovePayload
SigmaNodeEventPayload
SigmaNodeLabelEventPayload
SigmaOptions
StyleAnalysis
StylesDeclaration
TouchCoords
WheelCoords
Type Aliases
AtLeastOne
AutoRescaleContent
CoordinateConversionOverride
DataPredicate
EdgeLabelFontSizeMode
EdgeLabelPosition
EdgeReducer
EventsMapping
Extent
FontKey
ForbidBaseKeys
FullEdgeState
FullGraphState
FullNodeState
GraphicValue
LabelEventMode
LabelEventsSetting
LabelPosition
Listener
MouseCaptorEvents
MouseInteraction
NodeReducer
PartialButFor
PlainObject
RotationAlignment
SigmaAdditionalEvents
SigmaEdgeEvents
SigmaEdgeLabelEvents
SigmaEvents
SigmaEventType
SigmaNodeEvents
SigmaNodeLabelEvents
SigmaStageEventPayload
SigmaStageEvents
StageStyles
StageStyleValue
StatePredicate
StyleDependency
TouchCaptorEvents
Variables
DEFAULT_EDGE_PRIMITIVES
DEFAULT_NODE_PRIMITIVES
DEFAULT_PRIMITIVES
DEFAULT_STYLES
DEPTHLESS_STYLES
Functions
analyzeStyleDeclaration
defineSigmaOptions
evaluateDataPredicate
evaluateEdgeStyle
evaluateNodeStyle
evaluateStatePredicate
isInlineDataConditional
isInlineFunctionConditional
isInlineStateConditional
resolveGraphicValue
References
CameraEvents
EdgePrimitives
ExtractDepthLayersFromPrimitives
LabelAttachmentContent
LabelAttachmentContext
LabelAttachmentRenderer
NodePrimitives
PrimitivesDeclaration
sigma/utils
Interfaces
AnimateOptions
AtlasEntry
NormalizationFunction
PackableItem
ShelfCursor
Type Aliases
AtlasLookup
DepthRanges
Easing
Variables
ANIMATE_DEFAULTS
easings
HTML_COLORS
Functions
addPositionToDepthRanges
animateNodes
assign
colorToArray
colorToGLSLString
colorToIndex
colorToVec4
createElement
createNormalizationFunction
cubicIn
cubicInOut
cubicOut
exponentialIn
exponentialInOut
exponentialOut
extend
floatColor
getCorrectionRatio
getMatrixImpact
getPixelColor
getPixelRatio
hasBackdrop
hasForcedLabel
hasNewPartialProps
identity
indexToColor
linear
matrixFromCamera
multiply
multiplyVec2
nodeRotationFlags
packItemsOnPage
parseColor
parseFontString
pickingPixelCoords
quadraticIn
quadraticInOut
quadraticOut
removePositionFromDepthRanges
resolveEasing
rgbaToFloat
rotate
rotateVec2
scale
setMembership
shallowEqual
translate
validateGraph
Contributing
Publishing new versions
Creating new packages
GitHub
Mastodon
Select theme
Dark
Light
Auto
DEFAULT_SETTINGS
const
DEFAULT_SETTINGS
:
Settings
Defined in:
packages/sigma/src/settings.ts:94
