A descriptor for bus-related information to be associated with an edge.
Remarks
It consists of a bus ID defining the bus of the associated edge, two optional edge group IDs for specifying the edge grouping at the source and target side, respectively, and an optional boolean flag to mark the edge as fixed.
Every object except null can be used as a valid edge group ID. If there is no group ID defined for an edge or if null is set, a default group ID is used. Therefore, all such edges ending at the same node belong to the same group.
Default Values of Properties
| fixed | false | The associated edge is not fixed (unless otherwise specified in the constructor). |
| routingPolicy | ALWAYS | The edge is routed, ignoring the existing sketch. |
| sourceGroupId | YObject | All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor). |
| targetGroupId | YObject | All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor). |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.router.BusDescriptor
See Also
Constructors
Creates a new instance of BusRouterBusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.
Parameters
A map of options to pass to the method.
- busID - Object
- the ID of the bus to which the associated edge belongs
Creates a new instance of BusRouterBusDescriptor for the specified parameters and marks it as not fixed.
Creates a new instance of BusRouterBusDescriptor for the specified parameters and default group IDs.
Parameters
A map of options to pass to the method.
- busID - Object
- the ID of the bus to which the associated edge belongs
- fixed - boolean
trueif associated edge is fixed,falseotherwise
Creates a new instance of BusRouterBusDescriptor for the specified parameters.
Parameters
A map of options to pass to the method.
BusRouterBusDescriptor
(busID: Object, fixed: boolean, sourceGroupID: Object, targetGroupID: Object, routingPolicy: RoutingPolicy)Creates a new instance of BusRouterBusDescriptor for the specified parameters.
Parameters
A map of options to pass to the method.
- busID - Object
- the ID of the bus to which the associated edge belongs
- fixed - boolean
trueif associated edge is fixed,falseotherwise- sourceGroupID - Object
- the group ID of the source side
- targetGroupID - Object
- the group ID of the target side
- routingPolicy - RoutingPolicy
- one of the predefined routing policies
Properties
Gets or sets the bus ID.
Remarks
See Also
Gets or sets whether or not the associated edge is fixed.
Remarks
Default Value
false.The associated edge is not fixed (unless otherwise specified in the constructor).
See Also
Gets or sets the routing policy indicating if the edge associated with this descriptor is unconditionally routed or if the existing route determines whether a routing is even necessary.
Remarks
The routing policy only applies for edges that are not fixed in the first place. Fixed edges are never changed.
When only routing paths as needed, the algorithm tries to keep a lot of the existing routes and buses. For example, if two edges are defined to be on a common bus, but they are not yet, then only one of the edges is routed (given that the other has a proper orthogonal path) and parts of the other edge as the common bus. If optimizing the overall bus routing quality it might be better to use ALWAYS.
Default Value
Throws
- Exception({ name: 'ArgumentError' })
- if an unknown routing policy is given
See Also
Gets or sets the group ID for the source side of the edge.
Remarks
v but associated with different group IDs at this endpoint, use separate bus connections at v.Default Value
All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor).
See Also
null is set, a default group ID is used. Therefore, all associated edges ending at the same node belong to the same group.Gets or sets the group ID for the target side of the edge.
Remarks
v but associated with different group IDs at this endpoint, use separate bus connections at v.Default Value
All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor).
See Also
null is set, a default group ID is used. Therefore, all associated edges ending at the same node belong to the same group.Methods
Returns a hash code value for this BusRouterBusDescriptor instance.
Returns
- ↪number
- a hash code value