Module: edge-curve/src
Type Aliases
CreateEdgeCurveProgramOptions
Ƭ CreateEdgeCurveProgramOptions<N, E, G>: Object
Type parameters
| Name | Type |
|---|---|
N | extends Attributes = Attributes |
E | extends Attributes = Attributes |
G | extends Attributes = Attributes |
Type declaration
| Name | Type |
|---|---|
arrowHead | null | { lengthToThicknessRatio: number ; widenessToThicknessRatio: number } |
curvatureAttribute | string |
defaultCurvature | number |
drawLabel? | EdgeLabelDrawingFunction<N, E, G> |
Defined in
Variables
DEFAULT_EDGE_CURVATURE
• Const DEFAULT_EDGE_CURVATURE: 0.25
Defined in
DEFAULT_EDGE_CURVE_PROGRAM_OPTIONS
• Const DEFAULT_EDGE_CURVE_PROGRAM_OPTIONS: CreateEdgeCurveProgramOptions
Defined in
DEFAULT_INDEX_PARALLEL_EDGES_OPTIONS
• Const DEFAULT_INDEX_PARALLEL_EDGES_OPTIONS: Object
This function helps to identify parallel edges, to adjust their curvatures.
Type declaration
| Name | Type |
|---|---|
edgeIndexAttribute | string |
edgeMaxIndexAttribute | string |
edgeMinIndexAttribute | string |
Defined in
EdgeCurvedArrowProgram
• Const EdgeCurvedArrowProgram: EdgeProgramType
Defined in
default
• Const default: EdgeProgramType
Defined in
Functions
createDrawCurvedEdgeLabel
▸ createDrawCurvedEdgeLabel<N, E, G>(«destructured»): EdgeLabelDrawingFunction<N, E, G>
Type parameters
| Name | Type |
|---|---|
N | extends Attributes = Attributes |
E | extends Attributes = Attributes |
G | extends Attributes = Attributes |
Parameters
| Name | Type |
|---|---|
«destructured» | CreateEdgeCurveProgramOptions |
Returns
EdgeLabelDrawingFunction<N, E, G>
Defined in
edge-curve/src/edge-labels.ts:31
createEdgeCurveProgram
▸ createEdgeCurveProgram<N, E, G>(inputOptions?): EdgeProgramType<N, E, G>
Type parameters
| Name | Type |
|---|---|
N | extends Attributes = Attributes |
E | extends Attributes = Attributes |
G | extends Attributes = Attributes |
Parameters
| Name | Type |
|---|---|
inputOptions? | Partial<CreateEdgeCurveProgramOptions<N, E, G>> |
Returns
EdgeProgramType<N, E, G>
Defined in
indexParallelEdgesIndex
▸ indexParallelEdgesIndex(graph, options?): void
Parameters
| Name | Type |
|---|---|
graph | default<Attributes, Attributes, Attributes> |
options? | Partial<{ edgeIndexAttribute: string = "parallelIndex"; edgeMaxIndexAttribute: string = "parallelMaxIndex"; edgeMinIndexAttribute: string = "parallelMinIndex" }> |
Returns
void