@cesdk/engine 1.39.0 → 1.40.0-rc.1

package/index.d.ts

@@ -2323,19 +2323,39 @@ export declare class BlockAPI {
      * Sets the given typeface for the text block.
      * The current formatting, e.g., bold or italic, is retained as far as possible. Some formatting might change if the
      * new typeface does not support it, e.g. thin might change to light, bold to normal, and/or italic to non-italic.
+     * If the typeface is applied to the entire text block, its typeface property will be updated.
+     * If a run does not support the new typeface, it will fall back to the default typeface from the typeface property.
      * Required scope: 'text/character'
      * @param id - The text block whose font should be changed.
-     * @param fallbackFontFileUri - The URI of the fallback font file.
      * @param typeface - The new typeface.
+     * @param from - The start index of the UTF-16 range whose typeface should be changed.
+     *   If the value is negative and the block is currently being edited, this will fall back to the start of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the start of the entire text range.
+     * @param to - The UTF-16 index after the last grapheme whose typeface should be changed.
+     *   If the value is negative and the block is currently being edited, this will fall back to the end of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
      */
-    setTypeface(id: DesignBlockId, fallbackFontFileUri: string, typeface: Typeface): void;
+    setTypeface(id: DesignBlockId, typeface: Typeface, from?: number, to?: number): void;
     /**
      * Returns the current typeface of the given text block.
      * @param id - The text block whose typeface should be queried.
-     * @returns The typeface of the text block.
+     * @returns the typeface property of the text block. Does not return the typefaces of the text runs.
      * @throws An error if the block does not have a valid typeface.
      */
     getTypeface(id: DesignBlockId): Typeface;
+    /**
+     * Returns the current typefaces of the given text block.
+     * @param id - The text block whose typefaces should be queried.
+     * @param from - The start index of the grapheme range whose typefaces should be returned.
+     *   If the value is negative and the block is currently being edited, this will fall back to the start of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the start of the entire text range.
+     * @param to - The UTF-16 index after the last grapheme whose typefaces should be returned.
+     *   If the value is negative and the block is currently being edited, this will fall back to the end of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
+     * @returns The typefaces of the text block.
+     * @throws An error if the block does not have a valid typeface.
+     */
+    getTypefaces(id: DesignBlockId, from?: number, to?: number): Typeface[];
     /**
      * Returns the UTF-16 indices of the selected range of the text block that is currently being edited.
      * If both the start and end index of the returned range have the same value, then the text cursor is positioned at that index.