Skip to main content

Function: SigmaContainer()

SigmaContainer<N, E, G, NS, ES, GS, P>(props): ReactElement

Defined in: packages/core/src/components/SigmaContainer.tsx:181

The SigmaContainer component is responsible of create the Sigma instance, and provide it to its child components using a React Context that can be accessible via the hook useSigma.

<SigmaContainer id="sigma-graph">
  <MyCustomGraph />
</SigmaContainer>

See SigmaContainerProps for the component's properties.

Type Parameters​

• N extends Attributes = Attributes

• E extends Attributes = Attributes

• G extends Attributes = Attributes

• NS = unknown

• ES = unknown

• GS = unknown

• P extends PrimitivesDeclaration = PrimitivesDeclaration

Parameters​

props​

SigmaContainerProps<N, E, G, NS, ES, GS, P> & object & RefAttributes<null | Sigma<N, E, G, NS, ES, GS, P>>

Returns​

ReactElement