Class Link

Hierarchy (view full)

Entity<Spec & {
    props: LinkPropertiesSpec;
    source: EntityAnchorSpec;
    target: EntityAnchorSpec;
}>
- Link

Index

Constructors

Accessors

boundingBox id isSpecDirty konvasCache spec

Methods

_applyPropsToEntity _clearKonvasCache _computeBoundingBox _computeBoundingBoxWithSpec _convertSpec _createKonvasCache _generateLabels _getKonvasRepresentation _onAnchorsChange _onHighlightChange _onHoverChange _onMessageFlowsChange addAnnotation addHitBox addOnClickBehavior addOnDragBehavior applyCounterparts deleteAnnotation disable displayEntityDebugDetailsBox dispose enable forceUpdateBoundingBox getAllIdentifiers getAllKonvaNodes getAnnotations getBaseGroup getBaseShapes getBoundingBoxWithSpec getCurrentLabelAttrsDisplay getKonvaCacheAnchorsGroup getKonvaCacheLabels getKonvasRepresentation getLabelAnchoringRect getLabelEditionUIParams getNewLabelAttrsDisplay getTarget getType hideAnchors isCacheEmpty isDraggable pickHitBoxes regenerateAnchors regenerateKonvaCache removeClickBehaviors removeCounterparts removeHitBoxes resetBoundingBox setHitBoxes showAnchors update updateBoundingBox updateDisplayedText validateAndUpdate

Constructors

constructor

new Link(spec, ids, app): Link
Parameters
- spec: Spec & {
      props: {
          anchors: number[];
          isDrawing: undefined | boolean;
          kind: EDGE;
          message: undefined | {
              text: undefined | string;
              xOffset: number;
              yOffset: number;
          };
          messageVisibleKind: undefined | string;
          points: number[];
          status: undefined | {
              color: string;
          };
          type: string;
      };
      source: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
      target: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
  }
- ids: {
      containerId: string;
      shapeId: string;
      versionId: string;
  }
  - containerId: string
  - shapeId: string
  - versionId: string
- app: App
Returns Link
Inherited from Entity.constructor
- Defined in src/ts/entities/abstract/entity.ts:94

Properties

`Protected`_app

_app: App

`Protected`_boundingBox

_boundingBox: Nullable<BoundingBox> = null

`Protected`_cachedNode

_cachedNode: Nullable<Group> = null

`Protected`_currentKonvasDrawContext

_currentKonvasDrawContext: Nullable<DrawContext> = null

`Protected`_isKonvasCacheDirty

_isKonvasCacheDirty: boolean = false

`Protected`_konvasCache

_konvasCache: null | KonvasCache<{
    labels: LabelContainer[];
    main: Group;
    ring: Group;
}> = null

anchorsVisible

anchorsVisible: TrackableProperty<boolean> = ...

containerId

containerId: string

disabled

disabled: boolean = false

highlight

highlight: TrackableProperty<boolean> = ...

hitBoxes

hitBoxes: HitBox[] = []

hover

hover: TrackableProperty<boolean> = ...

isReady

isReady: boolean = false

isTask

isTask: boolean = false

lowLighted

lowLighted: TrackableProperty<boolean> = ...

messageFlowsTarget

messageFlowsTarget: TrackableProperty<boolean> = ...

metadata

metadata: any = {}

onHoverTimer

onHoverTimer: null | Timeout = null

shapeId

shapeId: string

versionId

versionId: string

Accessors

boundingBox

get boundingBox(): Nullable<BoundingBox>
Returns Nullable<BoundingBox>
Inherited from Entity.boundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:52

id

get id(): string
Returns string
Inherited from Entity.id
- Defined in src/ts/entities/abstract/entity.ts:56

isSpecDirty

get isSpecDirty(): boolean
Returns boolean
Inherited from Entity.isSpecDirty
- Defined in src/ts/entities/abstract/entity.ts:50

konvasCache

get konvasCache(): null | KonvasCache<Record<string, Shape<ShapeConfig> | Group | LabelContainer[]>>
Returns null | KonvasCache<Record<string, Shape<ShapeConfig> | Group | LabelContainer[]>>
Inherited from Entity.konvasCache
- Defined in src/ts/entities/abstract/entity.ts:86

spec

get spec(): DeepImmutable<T>
Returns DeepImmutable<T>
Inherited from Entity.spec
- Defined in src/ts/entities/abstract/entity.ts:45

Methods

`Protected`_applyPropsToEntity

_applyPropsToEntity(): void
Returns void
- Defined in src/ts/entities/link.ts:282

`Protected`_clearKonvasCache

_clearKonvasCache(): void
Returns void
Inherited from Entity._clearKonvasCache
- Defined in src/ts/entities/abstract/baseEntity.ts:110

`Protected`_computeBoundingBox

_computeBoundingBox(): void
Returns void
Inherited from Entity._computeBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:93

`Protected`_computeBoundingBoxWithSpec

_computeBoundingBoxWithSpec(): void
Returns void
Inherited from Entity._computeBoundingBoxWithSpec
- Defined in src/ts/entities/abstract/entity.ts:261

_convertSpec

_convertSpec(spec, shapeId?, containerId?, versionId?): {
    attachments: undefined | {
        title: string;
        type: string;
        typeDisplayName: string | {
            values: {
                lcid: number;
                value: unknown;
            }[];
        };
        url: string;
    }[];
    attributeDisplays: undefined | {
        anchor: undefined | string;
        height: number;
        horizontalAlignment: string;
        key: string;
        rotation: number;
        verticalAlignment: string;
        width: number;
        xOffset: number;
        yOffset: number;
    }[];
    attributes: undefined | {
        key: string;
        values: {
            lcid: number;
            value: unknown;
        }[];
    }[];
    containerId: undefined | string;
    id: undefined | string;
    properties:
        | {
            evType: undefined | string;
            type:
                | EV_START
                | EV_START_NON_INTERRUPTING
                | EV_INTERMEDIATE_NON_INTERRUPTING
                | EV_END
                | EV_INTERMEDIATE;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            columnSpan: number;
            rowSpan: number;
            type: POOL;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            columnSpan: number;
            isEmpty: undefined | boolean;
            rowSpan: number;
            type: LANE;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            type: CONDITION;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            type: RULE_OR | RULE_XOR | RULE_AND;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            decorations: undefined | {
                key: string;
                value: number;
            }[];
            detailContent: undefined | string;
            kpis: undefined | {
                status: string;
            };
            processMarker: undefined | string;
            requestEnabled: undefined | boolean;
            source: undefined | string;
            status: undefined | {
                action: undefined | string;
                color: undefined | string;
                name: undefined | string;
                percentage: undefined | number;
            };
            subscriptionEnabled: undefined | boolean;
            taskMarker: undefined | string;
            taskType: undefined | string;
            type:
                | TASK
                | FUNC
                | MAIN_PROCESS_IF
                | MAIN_PROCESS
                | SCENARIO_IF
                | SCENARIO
                | SUB_PROCESS_IF
                | SUB_PROCESS
                | TRANSACTION
                | CALL_ACTIVITY
                | IF_PLACEHOLDER
                | EXTERNAL_TASK
                | SUB_SUB_CATEGORY;
            version: undefined | string;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            anchors: number[];
            isDrawing: undefined | boolean;
            kind: EDGE;
            message: undefined | {
                text: undefined | string;
                xOffset: number;
                yOffset: number;
            };
            messageVisibleKind: undefined | string;
            points: number[];
            status: undefined | {
                color: string;
            };
            type: string;
        }
        | {
            columnSpan: number;
            rotation: number;
            rowSpan: number;
            text: string;
            type: LABEL;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        };
    related: undefined | {
        ids: string[];
        key: string;
        shortKey: undefined | string;
    }[];
    shapeId: undefined | string;
    source: undefined | {
        id: undefined | string;
        port: string;
        portOffset: undefined | number;
        portRatio: undefined | number;
        shapeId: undefined | string;
    };
    target: undefined | {
        id: undefined | string;
        port: string;
        portOffset: undefined | number;
        portRatio: undefined | number;
        shapeId: undefined | string;
    };
    versionId: undefined | string;
}
Parameters
- spec: DeepImmutableObject<Spec & {
      props: {
          anchors: number[];
          isDrawing: undefined | boolean;
          kind: EDGE;
          message: undefined | {
              text: undefined | string;
              xOffset: number;
              yOffset: number;
          };
          messageVisibleKind: undefined | string;
          points: number[];
          status: undefined | {
              color: string;
          };
          type: string;
      };
      source: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
      target: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
  }>
- shapeId: string = ''
- containerId: string = ''
- versionId: string = ''
Returns {
    attachments: undefined | {
        title: string;
        type: string;
        typeDisplayName: string | {
            values: {
                lcid: number;
                value: unknown;
            }[];
        };
        url: string;
    }[];
    attributeDisplays: undefined | {
        anchor: undefined | string;
        height: number;
        horizontalAlignment: string;
        key: string;
        rotation: number;
        verticalAlignment: string;
        width: number;
        xOffset: number;
        yOffset: number;
    }[];
    attributes: undefined | {
        key: string;
        values: {
            lcid: number;
            value: unknown;
        }[];
    }[];
    containerId: undefined | string;
    id: undefined | string;
    properties:
        | {
            evType: undefined | string;
            type:
                | EV_START
                | EV_START_NON_INTERRUPTING
                | EV_INTERMEDIATE_NON_INTERRUPTING
                | EV_END
                | EV_INTERMEDIATE;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            columnSpan: number;
            rowSpan: number;
            type: POOL;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            columnSpan: number;
            isEmpty: undefined | boolean;
            rowSpan: number;
            type: LANE;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            type: CONDITION;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            type: RULE_OR | RULE_XOR | RULE_AND;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            decorations: undefined | {
                key: string;
                value: number;
            }[];
            detailContent: undefined | string;
            kpis: undefined | {
                status: string;
            };
            processMarker: undefined | string;
            requestEnabled: undefined | boolean;
            source: undefined | string;
            status: undefined | {
                action: undefined | string;
                color: undefined | string;
                name: undefined | string;
                percentage: undefined | number;
            };
            subscriptionEnabled: undefined | boolean;
            taskMarker: undefined | string;
            taskType: undefined | string;
            type:
                | TASK
                | FUNC
                | MAIN_PROCESS_IF
                | MAIN_PROCESS
                | SCENARIO_IF
                | SCENARIO
                | SUB_PROCESS_IF
                | SUB_PROCESS
                | TRANSACTION
                | CALL_ACTIVITY
                | IF_PLACEHOLDER
                | EXTERNAL_TASK
                | SUB_SUB_CATEGORY;
            version: undefined | string;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        }
        | {
            anchors: number[];
            isDrawing: undefined | boolean;
            kind: EDGE;
            message: undefined | {
                text: undefined | string;
                xOffset: number;
                yOffset: number;
            };
            messageVisibleKind: undefined | string;
            points: number[];
            status: undefined | {
                color: string;
            };
            type: string;
        }
        | {
            columnSpan: number;
            rotation: number;
            rowSpan: number;
            text: string;
            type: LABEL;
        } & {
            column: undefined | number;
            height: number;
            kind: "shape" | "plane";
            laneId: undefined | string;
            poolId: undefined | string;
            row: undefined | number;
            type: string;
            width: number;
            x: number;
            y: number;
        };
    related: undefined | {
        ids: string[];
        key: string;
        shortKey: undefined | string;
    }[];
    shapeId: undefined | string;
    source: undefined | {
        id: undefined | string;
        port: string;
        portOffset: undefined | number;
        portRatio: undefined | number;
        shapeId: undefined | string;
    };
    target: undefined | {
        id: undefined | string;
        port: string;
        portOffset: undefined | number;
        portRatio: undefined | number;
        shapeId: undefined | string;
    };
    versionId: undefined | string;
}
- attachments: undefined | {
      title: string;
      type: string;
      typeDisplayName: string | {
          values: {
              lcid: number;
              value: unknown;
          }[];
      };
      url: string;
  }[]
- attributeDisplays: undefined | {
      anchor: undefined | string;
      height: number;
      horizontalAlignment: string;
      key: string;
      rotation: number;
      verticalAlignment: string;
      width: number;
      xOffset: number;
      yOffset: number;
  }[]
- attributes: undefined | {
      key: string;
      values: {
          lcid: number;
          value: unknown;
      }[];
  }[]
- containerId: undefined | string
- id: undefined | string
- properties:
      | {
          evType: undefined | string;
          type:
              | EV_START
              | EV_START_NON_INTERRUPTING
              | EV_INTERMEDIATE_NON_INTERRUPTING
              | EV_END
              | EV_INTERMEDIATE;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
      | {
          columnSpan: number;
          rowSpan: number;
          type: POOL;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
      | {
          columnSpan: number;
          isEmpty: undefined | boolean;
          rowSpan: number;
          type: LANE;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
      | {
          type: CONDITION;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
      | {
          type: RULE_OR | RULE_XOR | RULE_AND;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
      | {
          decorations: undefined | {
              key: string;
              value: number;
          }[];
          detailContent: undefined | string;
          kpis: undefined | {
              status: string;
          };
          processMarker: undefined | string;
          requestEnabled: undefined | boolean;
          source: undefined | string;
          status: undefined | {
              action: undefined | string;
              color: undefined | string;
              name: undefined | string;
              percentage: undefined | number;
          };
          subscriptionEnabled: undefined | boolean;
          taskMarker: undefined | string;
          taskType: undefined | string;
          type:
              | TASK
              | FUNC
              | MAIN_PROCESS_IF
              | MAIN_PROCESS
              | SCENARIO_IF
              | SCENARIO
              | SUB_PROCESS_IF
              | SUB_PROCESS
              | TRANSACTION
              | CALL_ACTIVITY
              | IF_PLACEHOLDER
              | EXTERNAL_TASK
              | SUB_SUB_CATEGORY;
          version: undefined | string;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
      | {
          anchors: number[];
          isDrawing: undefined | boolean;
          kind: EDGE;
          message: undefined | {
              text: undefined | string;
              xOffset: number;
              yOffset: number;
          };
          messageVisibleKind: undefined | string;
          points: number[];
          status: undefined | {
              color: string;
          };
          type: string;
      }
      | {
          columnSpan: number;
          rotation: number;
          rowSpan: number;
          text: string;
          type: LABEL;
      } & {
          column: undefined | number;
          height: number;
          kind: "shape" | "plane";
          laneId: undefined | string;
          poolId: undefined | string;
          row: undefined | number;
          type: string;
          width: number;
          x: number;
          y: number;
      }
- related: undefined | {
      ids: string[];
      key: string;
      shortKey: undefined | string;
  }[]
- shapeId: undefined | string
- source: undefined | {
      id: undefined | string;
      port: string;
      portOffset: undefined | number;
      portRatio: undefined | number;
      shapeId: undefined | string;
  }
- target: undefined | {
      id: undefined | string;
      port: string;
      portOffset: undefined | number;
      portRatio: undefined | number;
      shapeId: undefined | string;
  }
- versionId: undefined | string
Inherited from Entity._convertSpec
- Defined in src/ts/entities/abstract/entity.ts:288

`Protected`_createKonvasCache

_createKonvasCache(): void
Returns void
Overrides Entity._createKonvasCache
- Defined in src/ts/entities/link.ts:53

`Protected`_generateLabels

_generateLabels(_mainGroup?): LabelContainer[]
Parameters
- Optional_mainGroup: Group
Returns LabelContainer[]
- Defined in src/ts/entities/link.ts:83

`Protected`_getKonvasRepresentation

_getKonvasRepresentation(context, previousContext): KonvaRepresentation
Parameters
- context: DrawContext
- previousContext: Nullable<DrawContext>
Returns KonvaRepresentation
Overrides Entity._getKonvasRepresentation
- Defined in src/ts/entities/link.ts:256

`Protected`_onAnchorsChange

_onAnchorsChange(_value): void
Parameters
- _value: boolean
Returns void
Inherited from Entity._onAnchorsChange
- Defined in src/ts/entities/abstract/entity.ts:79

`Protected`_onHighlightChange

_onHighlightChange(_value): void
Parameters
- _value: boolean
Returns void
Inherited from Entity._onHighlightChange
- Defined in src/ts/entities/abstract/baseEntity.ts:85

`Protected`_onHoverChange

_onHoverChange(_value): void
Parameters
- _value: boolean
Returns void
Inherited from Entity._onHoverChange
- Defined in src/ts/entities/abstract/baseEntity.ts:89

`Protected`_onMessageFlowsChange

_onMessageFlowsChange(_value): void
Parameters
- _value: boolean
Returns void
Inherited from Entity._onMessageFlowsChange
- Defined in src/ts/entities/abstract/entity.ts:82

addAnnotation

addAnnotation(annotationId): void
Parameters
- annotationId: string
Returns void
Inherited from Entity.addAnnotation
- Defined in src/ts/entities/abstract/entity.ts:175

addHitBox

addHitBox(hitBox): void
Parameters
- hitBox: HitBox
Returns void
Inherited from Entity.addHitBox
- Defined in src/ts/entities/abstract/baseEntity.ts:181

addOnClickBehavior

addOnClickBehavior(params): void
Parameters
- params: {
      callback?: ((params: {
          e: KonvaEventObject<MouseEvent>;
          entity: BaseEntity;
          label?: LabelContainer;
      }) => void);
      eventType?: string;
      namespace?: string;
      targets?: (Shape<ShapeConfig> | Group)[];
  }
  - Optionalcallback?: ((params: {
        e: KonvaEventObject<MouseEvent>;
        entity: BaseEntity;
        label?: LabelContainer;
    }) => void)
    - (params): void
      Parameters
      params: {
          e: KonvaEventObject<MouseEvent>;
          entity: BaseEntity;
          label?: LabelContainer;
      }
      e: KonvaEventObject<MouseEvent>
      entity: BaseEntity
      Optionallabel?: LabelContainer
      Returns void
  - OptionaleventType?: string
  - Optionalnamespace?: string
  - Optionaltargets?: (Shape<ShapeConfig> | Group)[]
Returns void
Inherited from Entity.addOnClickBehavior
- Defined in src/ts/entities/abstract/baseEntity.ts:270

addOnDragBehavior

addOnDragBehavior(): void
Returns void
Inherited from Entity.addOnDragBehavior
- Defined in src/ts/entities/abstract/entity.ts:375

applyCounterparts

applyCounterparts(counterparts): void
Parameters
- counterparts: {
      elements: {
          active: undefined | boolean;
          classNames: undefined | string;
          descriptionTooltip: undefined | string;
          editable: undefined | boolean;
          icon: undefined | string;
          id: string;
          label: undefined | string;
          meta: unknown;
          showSelectedSubItems: undefined | boolean;
          subMenu: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
      }[];
      menus: {
          above: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
          after: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
          before: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
          below: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
          empty: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
          settings: undefined | {
              groups: {
                  asyncSearch: undefined | boolean;
                  elements: number[];
                  id: undefined | string | number;
                  label: undefined | string;
                  searchable: undefined | boolean;
              }[];
              layout: undefined | "simple" | "detailed";
              searchable: undefined | boolean;
              searchPlaceholder: undefined | string;
              title: undefined | string;
          };
      };
      type: undefined | "navigation" | "modeling";
  }
  - elements: {
        active: undefined | boolean;
        classNames: undefined | string;
        descriptionTooltip: undefined | string;
        editable: undefined | boolean;
        icon: undefined | string;
        id: string;
        label: undefined | string;
        meta: unknown;
        showSelectedSubItems: undefined | boolean;
        subMenu: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
    }[]
  - menus: {
        above: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
        after: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
        before: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
        below: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
        empty: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
        settings: undefined | {
            groups: {
                asyncSearch: undefined | boolean;
                elements: number[];
                id: undefined | string | number;
                label: undefined | string;
                searchable: undefined | boolean;
            }[];
            layout: undefined | "simple" | "detailed";
            searchable: undefined | boolean;
            searchPlaceholder: undefined | string;
            title: undefined | string;
        };
    }
    - above: undefined | {
          groups: {
              asyncSearch: undefined | boolean;
              elements: number[];
              id: undefined | string | number;
              label: undefined | string;
              searchable: undefined | boolean;
          }[];
          layout: undefined | "simple" | "detailed";
          searchable: undefined | boolean;
          searchPlaceholder: undefined | string;
          title: undefined | string;
      }
    - after: undefined | {
          groups: {
              asyncSearch: undefined | boolean;
              elements: number[];
              id: undefined | string | number;
              label: undefined | string;
              searchable: undefined | boolean;
          }[];
          layout: undefined | "simple" | "detailed";
          searchable: undefined | boolean;
          searchPlaceholder: undefined | string;
          title: undefined | string;
      }
    - before: undefined | {
          groups: {
              asyncSearch: undefined | boolean;
              elements: number[];
              id: undefined | string | number;
              label: undefined | string;
              searchable: undefined | boolean;
          }[];
          layout: undefined | "simple" | "detailed";
          searchable: undefined | boolean;
          searchPlaceholder: undefined | string;
          title: undefined | string;
      }
    - below: undefined | {
          groups: {
              asyncSearch: undefined | boolean;
              elements: number[];
              id: undefined | string | number;
              label: undefined | string;
              searchable: undefined | boolean;
          }[];
          layout: undefined | "simple" | "detailed";
          searchable: undefined | boolean;
          searchPlaceholder: undefined | string;
          title: undefined | string;
      }
    - empty: undefined | {
          groups: {
              asyncSearch: undefined | boolean;
              elements: number[];
              id: undefined | string | number;
              label: undefined | string;
              searchable: undefined | boolean;
          }[];
          layout: undefined | "simple" | "detailed";
          searchable: undefined | boolean;
          searchPlaceholder: undefined | string;
          title: undefined | string;
      }
    - settings: undefined | {
          groups: {
              asyncSearch: undefined | boolean;
              elements: number[];
              id: undefined | string | number;
              label: undefined | string;
              searchable: undefined | boolean;
          }[];
          layout: undefined | "simple" | "detailed";
          searchable: undefined | boolean;
          searchPlaceholder: undefined | string;
          title: undefined | string;
      }
  - type: undefined | "navigation" | "modeling"
Returns void
Inherited from Entity.applyCounterparts
- Defined in src/ts/entities/abstract/entity.ts:217

deleteAnnotation

deleteAnnotation(annotationId): void
Parameters
- annotationId: string
Returns void
Inherited from Entity.deleteAnnotation
- Defined in src/ts/entities/abstract/entity.ts:208

disable

disable(): void
Returns void
Inherited from Entity.disable
- Defined in src/ts/entities/abstract/baseEntity.ts:247

displayEntityDebugDetailsBox

displayEntityDebugDetailsBox(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
Inherited from Entity.displayEntityDebugDetailsBox
- Defined in src/ts/entities/abstract/entity.ts:342

dispose

dispose(): void
Returns void
Inherited from Entity.dispose
- Defined in src/ts/entities/abstract/entity.ts:114

enable

enable(): void
Returns void
Inherited from Entity.enable
- Defined in src/ts/entities/abstract/baseEntity.ts:252

forceUpdateBoundingBox

forceUpdateBoundingBox(): void
Returns void
Inherited from Entity.forceUpdateBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:313

getAllIdentifiers

getAllIdentifiers(): string[]
Returns string[]
Inherited from Entity.getAllIdentifiers
- Defined in src/ts/entities/abstract/entity.ts:371

getAllKonvaNodes

getAllKonvaNodes(): Node<NodeConfig>[]
Returns Node<NodeConfig>[]
Inherited from Entity.getAllKonvaNodes
- Defined in src/ts/entities/abstract/baseEntity.ts:166

getAnnotations

getAnnotations(): EntityAnnotation[]
Returns EntityAnnotation[]
Inherited from Entity.getAnnotations
- Defined in src/ts/entities/abstract/entity.ts:367

getBaseGroup

getBaseGroup(): Nullable<Group>
Returns Nullable<Group>
Inherited from Entity.getBaseGroup
- Defined in src/ts/entities/abstract/baseEntity.ts:154

getBaseShapes

getBaseShapes(): (Shape<ShapeConfig> | Group)[]
Returns (Shape<ShapeConfig> | Group)[]
Inherited from Entity.getBaseShapes
- Defined in src/ts/entities/abstract/baseEntity.ts:158

getBoundingBoxWithSpec

getBoundingBoxWithSpec(): null | {
    height: number;
    width: number;
    x: number;
    y: number;
}
Returns null | {
    height: number;
    width: number;
    x: number;
    y: number;
}
Inherited from Entity.getBoundingBoxWithSpec
- Defined in src/ts/entities/abstract/entity.ts:272

getCurrentLabelAttrsDisplay

getCurrentLabelAttrsDisplay(): null | {
    anchor: undefined | string;
    height: number;
    horizontalAlignment: string;
    key: string;
    rotation: number;
    verticalAlignment: string;
    width: number;
    xOffset: number;
    yOffset: number;
}
Get the attributes display of the current entity label

Returns null | {
    anchor: undefined | string;
    height: number;
    horizontalAlignment: string;
    key: string;
    rotation: number;
    verticalAlignment: string;
    width: number;
    xOffset: number;
    yOffset: number;
}
Inherited from Entity.getCurrentLabelAttrsDisplay
- Defined in src/ts/entities/abstract/entity.ts:419

getKonvaCacheAnchorsGroup

getKonvaCacheAnchorsGroup(): Group
Returns Group
Inherited from Entity.getKonvaCacheAnchorsGroup
- Defined in src/ts/entities/abstract/baseEntity.ts:300

getKonvaCacheLabels

getKonvaCacheLabels(): LabelContainer[]
Returns LabelContainer[]
Inherited from Entity.getKonvaCacheLabels
- Defined in src/ts/entities/abstract/baseEntity.ts:296

getKonvasRepresentation

getKonvasRepresentation(context, dirtyFlag, resetCacheDirtyFlag?): KonvaRepresentation
Parameters
- context: DrawContext
- dirtyFlag: ContextDirtyFlag
- resetCacheDirtyFlag: boolean = false
Returns KonvaRepresentation
Inherited from Entity.getKonvasRepresentation
- Defined in src/ts/entities/abstract/entity.ts:124

getLabelAnchoringRect

getLabelAnchoringRect(): IRect
Get the rect on which the label editor UI will be anchored

Most of the time, this will be the bounding box of the entity, but it may vary for some entities (e.g. links)

Returns IRect
Overrides Entity.getLabelAnchoringRect
- Defined in src/ts/entities/link.ts:331

getLabelEditionUIParams

getLabelEditionUIParams(): Partial<LabelEditParams>
Get custom parameters that will be used to display the label edition UI This can be used to fine-tune the position and style of the label edition UI

Returns Partial<LabelEditParams>
Overrides Entity.getLabelEditionUIParams
- Defined in src/ts/entities/link.ts:340

getNewLabelAttrsDisplay

getNewLabelAttrsDisplay(): {
    anchor: undefined | string;
    height: number;
    horizontalAlignment: string;
    key: string;
    rotation: number;
    verticalAlignment: string;
    width: number;
    xOffset: number;
    yOffset: number;
}
Get the attributes display of a new label

This method may be overridden by children to provide a custom label display

Returns {
    anchor: undefined | string;
    height: number;
    horizontalAlignment: string;
    key: string;
    rotation: number;
    verticalAlignment: string;
    width: number;
    xOffset: number;
    yOffset: number;
}
- anchor: undefined | string
- height: number
- horizontalAlignment: string
- key: string
- rotation: number
- verticalAlignment: string
- width: number
- xOffset: number
- yOffset: number
Overrides Entity.getNewLabelAttrsDisplay
- Defined in src/ts/entities/link.ts:313

getTarget

getTarget(app, zoomLevel): Vector2d
Parameters
- app: App
- zoomLevel: number
Returns Vector2d
Inherited from Entity.getTarget
- Defined in src/ts/entities/abstract/entity.ts:237

getType

getType(): string
Returns string
Overrides Entity.getType
- Defined in src/ts/entities/link.ts:44

hideAnchors

hideAnchors(): void
Returns void
Inherited from Entity.hideAnchors
- Defined in src/ts/entities/abstract/entity.ts:259

isCacheEmpty

isCacheEmpty(): boolean
Returns boolean
Inherited from Entity.isCacheEmpty
- Defined in src/ts/entities/abstract/baseEntity.ts:257

isDraggable

isDraggable(): boolean
Returns boolean
Inherited from Entity.isDraggable
- Defined in src/ts/entities/abstract/baseEntity.ts:173

pickHitBoxes

pickHitBoxes(mousePosition): boolean
Parameters
- mousePosition: Vector2d
Returns boolean
Inherited from Entity.pickHitBoxes
- Defined in src/ts/entities/abstract/baseEntity.ts:190

regenerateAnchors

regenerateAnchors(): void
Returns void
Inherited from Entity.regenerateAnchors
- Defined in src/ts/entities/abstract/entity.ts:119

regenerateKonvaCache

regenerateKonvaCache(): void
Returns void
Inherited from Entity.regenerateKonvaCache
- Defined in src/ts/entities/abstract/baseEntity.ts:242

removeClickBehaviors

removeClickBehaviors(params): void
Parameters
- params: {
  namespace?: string;
  targets?: (Shape<ShapeConfig> | Group)[];
  }
  - Optionalnamespace?: string
  - Optionaltargets?: (Shape<ShapeConfig> | Group)[]
Returns void
Inherited from Entity.removeClickBehaviors
- Defined in src/ts/entities/abstract/baseEntity.ts:261

removeCounterparts

removeCounterparts(): void
Returns void
Inherited from Entity.removeCounterparts
- Defined in src/ts/entities/abstract/entity.ts:226

removeHitBoxes

removeHitBoxes(): void
Returns void
Inherited from Entity.removeHitBoxes
- Defined in src/ts/entities/abstract/entity.ts:109

resetBoundingBox

resetBoundingBox(): void
Returns void
Inherited from Entity.resetBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:317

setHitBoxes

setHitBoxes(hitBoxes): void
Parameters
- hitBoxes: HitBox[]
Returns void
Inherited from Entity.setHitBoxes
- Defined in src/ts/entities/abstract/baseEntity.ts:177

showAnchors

showAnchors(): void
Returns void
Inherited from Entity.showAnchors
- Defined in src/ts/entities/abstract/entity.ts:257

update

update(spec): void
Faster because it isn't validating the spec
Parameters
- spec: Partial<DeepImmutableObject<Spec & {
      props: {
          anchors: number[];
          isDrawing: undefined | boolean;
          kind: EDGE;
          message: undefined | {
              text: undefined | string;
              xOffset: number;
              yOffset: number;
          };
          messageVisibleKind: undefined | string;
          points: number[];
          status: undefined | {
              color: string;
          };
          type: string;
      };
      source: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
      target: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
  }>>
Returns void
Inherited from Entity.update
- Defined in src/ts/entities/abstract/entity.ts:317

updateBoundingBox

updateBoundingBox(): void
Returns void
Inherited from Entity.updateBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:304

updateDisplayedText

updateDisplayedText(_layers, _options): void
Parameters
- _layers: Layer[]
- _options: FuncOptionsSpec
Returns void
Inherited from Entity.updateDisplayedText
- Defined in src/ts/entities/abstract/entity.ts:338

validateAndUpdate

validateAndUpdate(spec, ids?): void
Parameters
- spec: Partial<Spec & {
      props: {
          anchors: number[];
          isDrawing: undefined | boolean;
          kind: EDGE;
          message: undefined | {
              text: undefined | string;
              xOffset: number;
              yOffset: number;
          };
          messageVisibleKind: undefined | string;
          points: number[];
          status: undefined | {
              color: string;
          };
          type: string;
      };
      source: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
      target: {
          id: undefined | string;
          port: string;
          portOffset: undefined | number;
          portRatio: undefined | number;
          shapeId: undefined | string;
      };
  }>
- Optionalids: {
      containerId?: string;
      shapeId?: string;
      versionId?: string;
  }
  - OptionalcontainerId?: string
  - OptionalshapeId?: string
  - OptionalversionId?: string
Returns void
Inherited from Entity.validateAndUpdate
- Defined in src/ts/entities/abstract/entity.ts:323

Class Link

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

containerId: string

shapeId: string

versionId: string

Returns Link

Properties

Protected_app

Protected_boundingBox

Protected_cachedNode

Protected_currentKonvasDrawContext

Protected_isKonvasCacheDirty

Protected_konvasCache

anchorsVisible

containerId

disabled

highlight

hitBoxes

hover

isReady

isTask

lowLighted

messageFlowsTarget

metadata

onHoverTimer

shapeId

versionId

Accessors

boundingBox

Returns Nullable<BoundingBox>

id

Returns string

isSpecDirty

Returns boolean

konvasCache

Returns null | KonvasCache<Record<string, Shape<ShapeConfig> | Group | LabelContainer[]>>

spec

Returns DeepImmutable<T>

Methods

Protected_applyPropsToEntity

Returns void

Protected_clearKonvasCache

Returns void

Protected_computeBoundingBox

Returns void

Protected_computeBoundingBoxWithSpec

Returns void

_convertSpec

Parameters

attachments: undefined | { title: string; type: string; typeDisplayName: string | { values: { lcid: number; value: unknown; }[]; }; url: string; }[]

attributeDisplays: undefined | { anchor: undefined | string; height: number; horizontalAlignment: string; key: string; rotation: number; verticalAlignment: string; width: number; xOffset: number; yOffset: number; }[]

attributes: undefined | { key: string; values: { lcid: number; value: unknown; }[]; }[]

containerId: undefined | string

id: undefined | string

related: undefined | { ids: string[]; key: string; shortKey: undefined | string; }[]

shapeId: undefined | string

source: undefined | { id: undefined | string; port: string; portOffset: undefined | number; portRatio: undefined | number; shapeId: undefined | string; }

target: undefined | { id: undefined | string; port: string; portOffset: undefined | number; portRatio: undefined | number; shapeId: undefined | string; }

versionId: undefined | string

Protected_createKonvasCache

Returns void

Protected_generateLabels

Parameters

Returns LabelContainer[]

Protected_getKonvasRepresentation

Parameters

Returns KonvaRepresentation

Protected_onAnchorsChange

Parameters

Returns void

Protected_onHighlightChange

Parameters

`Protected`_app

`Protected`_boundingBox

`Protected`_cachedNode

`Protected`_currentKonvasDrawContext

`Protected`_isKonvasCacheDirty

`Protected`_konvasCache

`Protected`_applyPropsToEntity

`Protected`_clearKonvasCache

`Protected`_computeBoundingBox

`Protected`_computeBoundingBoxWithSpec

attachments: undefined | {
title: string;
type: string;
typeDisplayName: string | {
values: {
lcid: number;
value: unknown;
}[];
};
url: string;
}[]

attributeDisplays: undefined | {
anchor: undefined | string;
height: number;
horizontalAlignment: string;
key: string;
rotation: number;
verticalAlignment: string;
width: number;
xOffset: number;
yOffset: number;
}[]

attributes: undefined | {
key: string;
values: {
lcid: number;
value: unknown;
}[];
}[]

related: undefined | {
ids: string[];
key: string;
shortKey: undefined | string;
}[]

source: undefined | {
id: undefined | string;
port: string;
portOffset: undefined | number;
portRatio: undefined | number;
shapeId: undefined | string;
}

target: undefined | {
id: undefined | string;
port: string;
portOffset: undefined | number;
portRatio: undefined | number;
shapeId: undefined | string;
}

`Protected`_createKonvasCache

`Protected`_generateLabels

`Protected`_getKonvasRepresentation

`Protected`_onAnchorsChange

`Protected`_onHighlightChange

`Protected`_onHoverChange

`Protected`_onMessageFlowsChange

`Optional`callback?: ((params: {
e: KonvaEventObject<MouseEvent>;
entity: BaseEntity;
label?: LabelContainer;
}) => void)

`Optional`label?: LabelContainer

`Optional`eventType?: string

`Optional`namespace?: string

`Optional`targets?: (Shape<ShapeConfig> | Group)[]

Returns null | {
height: number;
width: number;
x: number;
y: number;
}