Class AnnotationsManager

Constructors

constructor

Methods

addAnnotationToEntity addEmptyAnnotationToEntity deleteAnnotationFromEntity

Constructors

constructor

Methods

addAnnotationToEntity

  • addAnnotationToEntity(entityId, annotation?): void
  • Internal

    Adds an annotation to the entity.

    Parameters

    • entityId: string

      The ID of the entity.

    • Optionalannotation: {
          attributes: undefined | {
              key: string;
              values: {
                  lcid: number;
                  value: unknown;
              }[];
          }[];
          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;
              }
              | {
                  type: string;
                  typeDisplayName: string;
              };
      }

      The annotation to add.

      • attributes: undefined | {
            key: string;
            values: {
                lcid: number;
                value: unknown;
            }[];
        }[]
      • 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;
            }
            | {
                type: string;
                typeDisplayName: string;
            }

    Returns void

addEmptyAnnotationToEntity

deleteAnnotationFromEntity

  • deleteAnnotationFromEntity(entityId, annotationId): void

  • Deletes an annotation from the entity.

    Parameters

    • entityId: string

      The ID of the entity.

    • annotationId: string

      The ID of the annotation to delete.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods