Skip to content
This is the
alpha v4 version
website.
Looking for the v3 documentation?
sigma.js
Search
Ctrl
K
Cancel
GitHub
Mastodon
Select theme
Dark
Light
Auto
Get started
Quickstart
Load a dataset
Style the graph
Add interactivity
How-to guides
Styling nodes
Colors & sizes
Shapes
Fill layers
Styling edges
Paths & colors
Extremities
Parallel edges & self-loops
Styling labels
Styles & positioning
Backdrops
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
Migrating from v3 to v4
Concepts
Styles and primitives
Lifecycle
Rendering
Coordinate systems
Node and edge sizes
Reference
Sigma API
Camera API
Settings
Events reference
Style properties
Style value types
Primitives schema
State flags
Examples
All examples
API reference
@sigma/export-image
Type Aliases
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
Variables
DEFAULT_DEPTH_LAYERS
References
default
Easing
easings
sigma/rendering
Classes
AttachmentManager
AttachmentProgram
BackdropProgram
Bucket
BucketCollection
DataTexture
EdgeDataTexture
EdgeLabelBackgroundProgram
EdgeLabelProgram
EdgeProgram
LabelBackgroundProgram
LabelProgram
NodeDataTexture
NodeProgram
Program
Interfaces
ArrowExtremityOptions
AttributeSpecification
BackdropDisplayData
BackdropShaderOptions
BarExtremityOptions
CircleExtremityOptions
CreateBackdropProgramOptions
CreateEdgeLabelBackgroundProgramOptions
CreateEdgeLabelProgramOptions
CreateLabelProgramOptions
CurvedPathOptions
CurvedSPathOptions
DiamondExtremityOptions
DiamondOptions
EdgeContextFields
EdgeExtremity
EdgeLabelBackgroundData
EdgeLabelOptions
EdgeLabelShaderOptions
EdgeLayer
EdgeLifecycleContext
EdgeLifecycleHooks
EdgePath
EdgeProgramOptions
FragmentLayer
GeneratedBackdropShaders
GeneratedEdgeLabelShaders
GeneratedEdgeShaders
GeneratedLabelShaders
GeneratedShaders
InstancedProgramDefinition
LabelBackgroundData
LabelFontOptions
LabelOptions
LabelShaderOptions
LayerContext
LayerDashedOptions
LayerFillOptions
LayerLifecycleContext
LayerLifecycleHooks
LoopPathOptions
NodeProgramOptions
PrePassDefinition
ProgramAttributeSpecification
ProgramDefinition
ProgramInfo
ResolvedEdgeIds
SDFShape
ShaderGenerationOptions
SquareExtremityOptions
SquareOptions
StepCurvedPathOptions
StepPathOptions
TriangleOptions
Type Aliases
BackdropProgramType
DashSize
DashSizeMode
EdgeLabelBackgroundProgramType
EdgeLabelColorSpecification
EdgeLabelProgramType
EdgeProgramType
EdgeShaderGenerationOptions
GapFilling
LabelBackgroundProgramType
LabelProgramType
Mat3
Mat4
NodeProgramType
ProcessItemFunction
ProgramType
SolidExtremities
SolidMargin
UniformSpecification
ValueSource
Vec2
Vec3
Vec4
Variables
GLSL_GET_LABEL_DIRECTION
GLSL_NODE_SIZE_TO_PIXELS
GLSL_ROTATE_2D
GLSL_SDF_BOX
GLSL_SDF_ROTATED_BOX
GLSL_SDF_ROUNDED_BOX
GLSL_SDF_ROUNDED_ROTATED_BOX
LABEL_ID_OFFSET
POSITION_MODE_MAP
Functions
clampZIndex
clearShapeInstanceRegistry
collectAttributes
collectBackdropUniforms
collectLabelUniforms
collectUniforms
createBackdropProgram
createEdgeLabelBackgroundProgram
createEdgeLabelProgram
createEdgeProgram
createLabelBackgroundProgram
createLabelProgram
createNodeProgram
extremityArrow
extremityBar
extremityCircle
extremityDiamond
extremitySquare
generateBackdropFragmentShader
generateBackdropShaders
generateBackdropVertexShader
generateEdgeLabelShaders
generateEdgeShaders
generateFindEdgeDistance
generateFragmentShader
generateLabelFragmentShader
generateLabelShaders
generateLabelVertexShader
generateNodeShapeSelectorGLSL
generateShaders
generateShapeSelectorGLSL
generateVertexShader
getAllShapeGLSL
getAttributesItemsCount
getRegisteredShapeInstance
getRegisteredShapeSlugs
getShapeFromSlug
getShapeGLSL
getShapeGLSLForShapes
getShapeId
isAttributeSource
killProgram
layerDashed
layerFill
layerPlain
loadFragmentShader
loadProgram
loadTransformFeedbackProgram
loadVertexShader
numberToGLSLFloat
pathCurved
pathCurvedS
pathLine
pathLoop
pathStep
pathStepCurved
registerShapeInstance
sdfCircle
sdfDiamond
sdfSquare
sdfTriangle
sigma/settings
Interfaces
Settings
Variables
DEFAULT_SETTINGS
Functions
resolveSettings
validateSettings
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
hasNewPartialProps
identity
indexToColor
linear
matrixFromCamera
multiply
multiplyVec2
packItemsOnPage
parseColor
parseFontString
quadraticIn
quadraticInOut
quadraticOut
removePositionFromDepthRanges
resolveEasing
rgbaToFloat
rotate
scale
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:88
