IEdgeDefaults

Interface used by IGraph to declare and obtain the defaults for edges and their labels and ports.

Inheritance Hierarchy

IEdgeDefaults

Remarks

Note that changing these defaults does not change properties of already created model items. Rather, only items created after the change are affected.

Examples

Setting defaults for edges

// the defaults for edges can be set on the IEdgeDefaults instance
// which can be retrieved from the graph's EdgeDefaults property
graph.edgeDefaults.style = new PolylineEdgeStyle({
  stroke: Stroke.BLACK,
  targetArrow: new Arrow(ArrowType.STEALTH),
})

// the defaults for edge labels can be set on the ILabelDefaults instance
// found at the Labels property of the edge defaults
graph.edgeDefaults.labels.layoutParameter =
  new EdgeSegmentLabelModel().createParameterFromSource(0)
graph.edgeDefaults.labels.style = new LabelStyle()

Type Details

yFiles module: view

Properties

labels

: ILabelDefaults

Gets or sets the defaults for labels at edges.

Property Value

The label defaults.

Examples

graph.edgeDefaults.labels.layoutParameter =
  new EdgeSegmentLabelModel().createParameterFromSource(0)

ports

: IPortDefaults

Gets or sets the defaults for ports at edges.

Remarks

Note that these are not the defaults for the sourcePorts or targetPorts. Instead, these are the defaults for the ports in the edge's ports collection to which other edges can connect.

Property Value

The port defaults.

Examples

// don't remove node labels after their
// last adjacent edge has been removed
graph.edgeDefaults.ports.autoCleanUp = false

shareStyleInstance

: boolean

Gets or sets a value indicating whether the style instance should be shared referentially or cloned upon a call to getStyleInstance.

Property Value

true if the reference should be shared; false otherwise.

Examples

Shared vs. cloned styles

const n1 = graph.createNodeAt(new Point(0, 100))
const n2 = graph.createNodeAt(new Point(100, 0))
const n3 = graph.createNodeAt(new Point(100, 50))
const n4 = graph.createNodeAt(new Point(100, 100))
const n5 = graph.createNodeAt(new Point(100, 150))

const defaultStyle = new PolylineEdgeStyle()
graph.edgeDefaults.style = defaultStyle

// share style instances
graph.edgeDefaults.shareStyleInstance = true
const e1 = graph.createEdge(n1, n2)
const e2 = graph.createEdge(n1, n3)
// e1.style === defaultStyle; e2.style === defaultStyle; e1.style === e2.style;
defaultStyle.stroke = Stroke.RED // e1 and e2 both turn red, too

// clone style instances
graph.edgeDefaults.shareStyleInstance = false
const e3 = graph.createEdge(n1, n4)
const e4 = graph.createEdge(n1, n5)
// e3.style !== defaultStyle; e4.style !== defaultStyle; e3.style !== e4.style;
defaultStyle.stroke = Stroke.YELLOW // e3 and e4 don't change their color

style

: IEdgeStyle

Gets or sets the style to use for edges.

Remarks

Depending on the setting of shareStyleInstance, the getStyleInstance method should return a clone of this instance or the very same instance.

Property Value

The style to use as a template.

Examples

graph.edgeDefaults.style = new PolylineEdgeStyle({
  stroke: Stroke.BLACK,
  targetArrow: new Arrow(ArrowType.STEALTH),
})

Methods

getStyleInstance

() : IEdgeStyle

Factory method that returns a style instance for use with newly created edges.

Remarks

Most implementations will yield either a clone of or the style property, if shareStyleInstance is enabled, but they might use more complicated logic, too.

Returns

↪IEdgeStyle: The style to use, which for most implementations is either a clone of or the style property, if shareStyleInstance is enabled.

IEdgeDefaults

Remarks

Examples

Type Details

See Also

Properties

labels

Property Value

Examples

ports

Remarks

Property Value

Examples

shareStyleInstance

Property Value

Examples

See Also

style

Remarks

Property Value

Examples

See Also

Methods

getStyleInstance

Remarks

Returns