This class can be used to manage the canvas elements

It provides more granular methods that app.update() to add, update, delete, find or get elements

[!] We are talking about elements, not entities. The provided data is not the same as the one used by the app for entities. The elements are defined in the json spec file, and are used to render the entities on the canvas.

Constructors

Accessors

  • get counterparts(): {
        add: Object;
        delete: Object;
        find: Object;
        get: Object;
        update: Object;
    }
  • Returns {
        add: Object;
        delete: Object;
        find: Object;
        get: Object;
        update: Object;
    }

    • add: Object
    • delete: Object
    • find: Object
    • get: Object
    • update: Object
  • get elements(): {
        add: Object;
        delete: Object;
        find: Object;
        get: Object;
        patch: Object;
        update: Object;
    }
  • Returns {
        add: Object;
        delete: Object;
        find: Object;
        get: Object;
        patch: Object;
        update: Object;
    }

    • add: Object
    • delete: Object
    • find: Object
    • get: Object
    • patch: Object
    • update: Object

Methods

  • Internal

    Get a copy of the app data

    Returns {
        configuration: {
            primary: undefined | number;
            secondary: undefined | number;
            vertical: boolean;
        }[];
        elements: {
            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;
        }[];
        relatedElements: undefined | {
            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;
                };
        }[];
    }

    • configuration: {
          primary: undefined | number;
          secondary: undefined | number;
          vertical: boolean;
      }[]
    • elements: {
          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;
      }[]
    • relatedElements: undefined | {
          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;
              };
      }[]