Skip to main content

Interface: SnapConnectionPartial

Partial definition of a connection between products.

The SnapConnectionPartial interface provides the optional properties that describe the nature and type of connection between products. These properties define the relationship between connected products and special connection behaviors.

This partial interface is used as a base for complete connection definitions and for creating new connections before all required properties are known.

Extended by​

Properties​

hasAutoInserted?​

optional hasAutoInserted: string | boolean

Indicates this connection includes an auto-inserted product.

When true or set to an instance ID string, this connection involves an automatically inserted product. This helps track connections that were made through automatic insertion rules.

This property helps maintain the integrity of auto-inserted product relationships during scene modifications.

isAutoInserted?​

optional isAutoInserted: string | boolean

Indicates this product was automatically inserted.

When true or set to an instance ID string, this product was automatically inserted by a rule rather than explicitly placed by the user. This typically happens when system rules determine that an adapter or connector is needed between products.

Auto-inserted products may have different UI treatment or special behavior when the scene is modified.

isChild?​

optional isChild: boolean

Indicates a parent-child relationship where the source is the parent.

When true, the current product is considered the parent of the connected product. This creates a hierarchical relationship where the child product is dependent on this product. When this product is moved, its children move with it.

This is the inverse of the isParent property, viewing the same relationship from the opposite direction.

isConnector?​

optional isConnector: boolean

Indicates this product serves as a connector.

When true, the current product acts as a connector between the target product and some other product. Connectors join two or more products that would not otherwise be directly compatible.

Connector products have special behavior in the modular system, such as maintaining connections on both sides when moved.

isParent?​

optional isParent: boolean

Indicates a parent-child relationship where the target is the parent.

When true, the connected product is considered the parent of the current product. This creates a hierarchical relationship where the child product is dependent on the parent. When a parent is moved, its children move with it.

Parent-child relationships are fundamental to building complex structures with proper dependency chains.

isSibling?​

optional isSibling: boolean

Indicates a sibling relationship between products.

When true, the connected products are considered siblings at the same level of the hierarchy. Siblings have no dependency relationship and can be moved independently of each other.

Sibling relationships are used for products that connect laterally or adjacently without a structural dependency.

productUId?​

optional productUId: string

Instance ID of target product.

This property optionally identifies which specific product instance is on the target end of this connection. This becomes required in a full connection.

snapIdFrom?​

optional snapIdFrom: string

ID of snap point on the source product.

This property optionally identifies which snap point on the current product is used in this connection. This becomes required in a full connection.

snapIdTo?​

optional snapIdTo: string

ID of snap point on the target product.

This property optionally identifies which snap point on the target product is used in this connection. This becomes required in a full connection.

withConnector?​

optional withConnector: boolean

Indicates the target product serves as a connector.

When true, the target product acts as a connector between the current product and some other product. This flag helps track connector relationships from the perspective of products connected through a connector.

This property helps maintain proper relationships when products are connected indirectly through intermediate connector products.