TLShapeUtilCanBindOpts

See source code
Table of contents

Options passed to ShapeUtil.canBind. A binding that could be made. At least one of fromShape or toShape will belong to this shape util.

The shapes may be full TLShape objects when available, or just { type } stubs when the shape hasn't been created yet (e.g. during arrow creation). Use 'id' in shape to check whether the full shape is available.

interface TLShapeUtilCanBindOpts<Shape extends TLShape = TLShape> {}

Properties

bindingType

The type of binding.

bindingType: string

fromShape

The shape referenced by the fromId of the binding, or a { type } stub if unavailable.

fromShape:
  | {
      type: TLShape['type']
    }
  | TLShape

fromShapeType

Deprecated: Use fromShape.type instead.

The type of shape referenced by the fromId of the binding.

fromShapeType: TLShape['type']

toShape

The shape referenced by the toId of the binding, or a { type } stub if unavailable.

toShape:
  | {
      type: TLShape['type']
    }
  | TLShape

toShapeType

Deprecated: Use toShape.type instead.

The type of shape referenced by the toId of the binding.

toShapeType: TLShape['type']

Prev
TLShapeUtilCanBeLaidOutOpts
Next
TLShapeUtilCanvasSvgDef