Update FastImageSequence.ts

mediamonks · May 13, 2024 · 3e5d484 · 3e5d484
1 parent 4d4e9fa
commit 3e5d484
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/lib/FastImageSequence.ts b/src/lib/FastImageSequence.ts
@@ -278,8 +278,12 @@ export class FastImageSequence {
   }
 
   /**
-   * Set the size of the image sequence.
-    * @param options
+   * Set the size and alignment of the image sequence on the canvas.
+   *
+   * @param {Partial<FastImageSequenceSizeOptions>} options - An object containing the size and alignment options.
+   * @property {string} options.size - How the image should be resized to fit the canvas. It can be either 'contain' or 'cover'.
+   * @property {number} options.horizontalAlign - The horizontal alignment of the image. It should be a number between 0 and 1.
+   * @property {number} options.verticalAlign - The vertical alignment of the image. It should be a number between 0 and 1.
    */
   public setSize(options: Partial<FastImageSequenceSizeOptions>) {
     this.options = {...this.options, ...options};