API reference / Common / Engine types / AnnotationCommand

Type Alias: AnnotationCommand

type AnnotationCommand = 
  | {
  insertAnnotations: {
     index: number;
     annotations: unknown[];
  };
}
  | {
  translateAnnotations: {
     ids: AnnotationId[];
     dx: number;
     dy: number;
  };
}
  | {
  resizeAnnotations: {
     ids: AnnotationId[];
     sx: number;
     sy: number;
     anchorX: number;
     anchorY: number;
  };
}
  | {
  updateAnnotations: {
     annotations: unknown[];
  };
}
  | {
  deleteAnnotations: {
     ids: AnnotationId[];
  };
}
  | {
  reorderAnnotations: {
     ids: AnnotationId[];
     order: ObjectZOrder;
  };
}
  | {
  setAnnotationRichContents: {
     id: AnnotationId;
     richContents: string;
     modified: string;
  };
}
  | {
  editAnnotationShape: {
     id: AnnotationId;
     command: ShapeCommand;
  };
};

An edit intent on one page's annotations — the page is the EditAnnotation wrapping it. Annotations are addressed by id; ids not on the page are skipped.