Skip to main content

sigma/src/settings.Settings

Sigma.js settings

Type parameters

NameType
Nextends Attributes = Attributes
Eextends Attributes = Attributes
Gextends Attributes = Attributes

Properties

allowInvalidContainer

allowInvalidContainer: boolean

Defined in

sigma/src/settings.ts:77


defaultDrawEdgeLabel

defaultDrawEdgeLabel: EdgeLabelDrawingFunction<N, E, G>

Defined in

sigma/src/settings.ts:57


defaultDrawNodeHover

defaultDrawNodeHover: NodeHoverDrawingFunction<N, E, G>

Defined in

sigma/src/settings.ts:59


defaultDrawNodeLabel

defaultDrawNodeLabel: NodeLabelDrawingFunction<N, E, G>

Defined in

sigma/src/settings.ts:58


defaultEdgeColor

defaultEdgeColor: string

Defined in

sigma/src/settings.ts:44


defaultEdgeType

defaultEdgeType: string

Defined in

sigma/src/settings.ts:45


defaultNodeColor

defaultNodeColor: string

Defined in

sigma/src/settings.ts:42


defaultNodeType

defaultNodeType: string

Defined in

sigma/src/settings.ts:43


edgeLabelColor

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

Defined in

sigma/src/settings.ts:53


edgeLabelFont

edgeLabelFont: string

Defined in

sigma/src/settings.ts:50


edgeLabelSize

edgeLabelSize: number

Defined in

sigma/src/settings.ts:51


edgeLabelWeight

edgeLabelWeight: string

Defined in

sigma/src/settings.ts:52


edgeProgramClasses

edgeProgramClasses: Object

Index signature

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

Defined in

sigma/src/settings.ts:82


edgeReducer

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

Defined in

sigma/src/settings.ts:69


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


itemSizesReference

itemSizesReference: "screen" | "positions"

Defined in

sigma/src/settings.ts:56


labelColor

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

Defined in

sigma/src/settings.ts:49


labelDensity

labelDensity: number

Defined in

sigma/src/settings.ts:63


labelFont

labelFont: string

Defined in

sigma/src/settings.ts:46


labelGridCellSize

labelGridCellSize: number

Defined in

sigma/src/settings.ts:64


labelRenderedSizeThreshold

labelRenderedSizeThreshold: number

Defined in

sigma/src/settings.ts:65


labelSize

labelSize: number

Defined in

sigma/src/settings.ts:47


labelWeight

labelWeight: string

Defined in

sigma/src/settings.ts:48


maxCameraRatio

maxCameraRatio: null | number

Defined in

sigma/src/settings.ts:74


minCameraRatio

minCameraRatio: null | number

Defined in

sigma/src/settings.ts:73


minEdgeThickness

minEdgeThickness: number

Defined in

sigma/src/settings.ts:60


nodeHoverProgramClasses

nodeHoverProgramClasses: Object

Index signature

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

Defined in

sigma/src/settings.ts:81


nodeProgramClasses

nodeProgramClasses: Object

Index signature

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

Defined in

sigma/src/settings.ts:80


nodeReducer

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

Defined in

sigma/src/settings.ts:68


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


zIndex

zIndex: boolean

Defined in

sigma/src/settings.ts:72


zoomToSizeRatioFunction

zoomToSizeRatioFunction: (ratio: number) => number

Type declaration

▸ (ratio): number

Parameters
NameType
rationumber
Returns

number

Defined in

sigma/src/settings.ts:55