@syncfusion/ej2-image-editor 23.2.7 → 24.1.41

package/src/image-editor/base/image-editor.d.ts

@@ -2,7 +2,7 @@ import { Component, INotifyPropertyChanged, ModuleDeclaration, BlazorDotnetObjec
 import { EmitType } from '@syncfusion/ej2-base';
 import { ItemModel, ClickEventArgs } from '@syncfusion/ej2-navigations';
 import { ChildProperty } from '@syncfusion/ej2-base';
-import { ImageEditorModel, FinetuneSettingsModel, ZoomSettingsModel, SelectionSettingsModel } from './image-editor-model';
+import { ImageEditorModel, FinetuneSettingsModel, ZoomSettingsModel, SelectionSettingsModel, FontFamilyModel } from './image-editor-model';
 import { SelectionChangeEventArgs, Transition, ArrowheadType, ResizeEventArgs, FrameType, FrameLineStyle, FrameChangeEventArgs } from './../index';
 import { ZoomEventArgs, PanEventArgs, CropEventArgs, RotateEventArgs, FlipEventArgs, ShapeChangeEventArgs } from './../index';
 import { ToolbarEventArgs, OpenEventArgs, SaveEventArgs, BeforeSaveEventArgs, Point, ShapeSettings, ImageFilterEventArgs } from './../index';
@@ -179,6 +179,23 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
      */
     fillColor: string;
 }
+/**
+ * Predefine the font families that populate in font family dropdown list from the toolbar.
+ */
+export declare class FontFamily extends ChildProperty<FontFamily> {
+    /**
+     * Specifies default font family selection
+     *
+     * @default 'Arial'
+     */
+    default: string;
+    /**
+     * Specifies default font family items
+     *
+     * @default null
+     */
+    items: DropDownButtonItemModel[];
+}
 /**
  * The Image Editor is a graphical user interface for editing images.
  *
@@ -313,6 +330,40 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
     frameDestPoints: ImageDimension;
     /** @hidden */
     cxtTbarHeight: number;
+    /** @hidden */
+    straightenPoint: Point;
+    /** @hidden */
+    prevStraightenedDegree: number;
+    /** @hidden */
+    tempStraighten: number;
+    /** @hidden */
+    isStraightening: boolean;
+    /** @hidden */
+    prevEventSelectionPoint: SelectionPoint;
+    /** @hidden */
+    prevEventObjPoint: CurrentObject;
+    /** @hidden */
+    isCroppedEvent: boolean;
+    /** @hidden */
+    isResizeOkBtn: boolean;
+    /** @hidden */
+    isFinetuning: boolean;
+    /** @hidden */
+    isZoomBtnClick: boolean;
+    /** @hidden */
+    isFinetuneBtnClick: boolean;
+    /** @hidden */
+    isFilterCanvasClick: boolean;
+    /** @hidden */
+    isFrameBtnClick: boolean;
+    /** @hidden */
+    curFilterObjEvent: object;
+    /** @hidden */
+    curFinetuneObjEvent: object;
+    /** @hidden */
+    curFrameObjEvent: object;
+    /** @hidden */
+    isChangesSaved: boolean;
     private lowerContext;
     private upperContext;
     private inMemoryContext;
@@ -563,6 +614,10 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      *
      */
     selectionSettings: SelectionSettingsModel;
+    /**
+     * Predefine the font families that populate in font family dropdown list from the toolbar.
+     */
+    fontFamily: FontFamilyModel;
     /**
      * Event callback that is raised before an image is saved.
      *
@@ -674,6 +729,14 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * @event click
      */
     click: EmitType<ImageEditorClickEventArgs>;
+    /**
+     * Event callback that is raised after shape changing action is performed in an image editor.
+     * @remarks
+     * This event is triggered after changing stroke color, fill Color, and stroke width property for the shapes and after the shape is applied to the canvas while clicking the OK button in toolbar.
+     *
+     * @event shapeChange
+     */
+    shapeChange: EmitType<ShapeChangeEventArgs>;
     /**
      * Event callback that is raised when opening the quick access toolbar.
      *
@@ -1015,7 +1078,7 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * @param {string} strokeColor - Specifies the stroke color of path.
      * @returns {boolean}.
      */
-    drawPath(pointColl: Point[], strokeWidth?: number, strokeColor?: string): boolean;
+    drawPath(pointColl: Point[], strokeWidth?: number, strokeColor?: string, opacity?: number): boolean;
     /**
      * Draw a rectangle on an image.
      *
@@ -1058,10 +1121,11 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * @param {number} height - Specifies the height of the image.
      * @param {boolean} isAspectRatio - Specifies whether to maintain aspect ratio or not.
      * @param {number} degree - Specifies the degree to rotate the image.
+     * @param {number} opacity - Specifies the value for the image.
      * @returns {boolean}.
      *
      */
-    drawImage(data: string | ImageData, x?: number, y?: number, width?: number, height?: number, isAspectRatio?: boolean, degree?: number): boolean;
+    drawImage(data: string | ImageData, x?: number, y?: number, width?: number, height?: number, isAspectRatio?: boolean, degree?: number, opacity?: number): boolean;
     /**
      * Select a shape based on the given shape id.
      * Use 'getShapeSettings' method to get the shape id which is then passed to perform selection.
@@ -1180,6 +1244,37 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * @returns {boolean}.
      */
     drawFrame(frameType: FrameType, color?: string, gradientColor?: string, size?: number, inset?: number, offset?: number, borderRadius?: number, frameLineStyle?: FrameLineStyle, lineCount?: number): boolean;
+    /**
+     * Straightens an image by rotating it clockwise or counterclockwise.
+     *
+     * @param {number} degree - The degree value specifying the amount of rotation for straightening the image.
+     * Positive values indicate clockwise rotation, while negative values indicate counterclockwise rotation.
+     *
+     * @remarks
+     * The degree value should be within the range of -45 to +45 degrees for accurate straightening.
+     *
+     * @returns {boolean} - A boolean value indicating the success of the straightening operation.
+     */
+    straightenImage(degree: number): boolean;
+    /**
+     * This method is used to update the existing shapes by changing its height, width, color, and font styles in the component.
+     * Use 'getShapeSettings' method to get the shape which is then passed to change the options of a shape.
+     * {% codeBlock src='image-editor/updateShape/index.md' %}{% endcodeBlock %}
+     *
+     * @param {ShapeSettings} setting - Specifies the shape settings to be updated for the shape on an image.
+     * @returns {boolean}.
+     *
+     */
+    updateShape(setting: ShapeSettings): boolean;
+    /**
+     * Duplicates a shape based on the given shape ID in the ImageEditor.
+     * Use 'getShapeSettings' method to get the shape and then pass a shapeId from the returned shape to clone a shape.
+     *
+     * @param {string} shapeId - Specifies the shape id to clone a shape on an image.
+     * @returns {boolean}.
+     *
+     */
+    cloneShape(shapeId: string): boolean;
     private toolbarTemplateFn;
     private quickAccessToolbarTemplateFn;
     private templateParser;
@@ -1373,6 +1468,7 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * Apply rotate image.
      *
      * @param { string } rotate - Specifies the direction of rotation.
+     * @param { boolean } isPreventURC - Specifies to update undo redo collection.
      * @hidden
      * @returns {void}.
      */
@@ -1408,6 +1504,30 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * @returns {string}.
      */
     getDefaultFilter(): string;
+    /**
+     * Performs Straightening action.
+     *
+     * @hidden
+     * @returns {void}.
+     */
+    setStraighten(value: number, isMethod?: boolean): void;
+    private duplicateImage;
+    private performStraighten;
+    /**
+     * Straightens base image.
+     *
+     * @hidden
+     * @returns {void}.
+     */
+    straightenBaseImageCanvas(): void;
+    /**
+     * Returns rotated canvas dimension.
+     *
+     * @hidden
+     * @returns {void}.
+     */
+    getRotatedCanvasDim(width: number, height: number, angle: number): Dimension;
+    private getStraightenFlipState;
     /**
      * To Initialize the component rendering
      *
@@ -1439,4 +1559,5 @@ export declare class ImageEditor extends Component<HTMLDivElement> implements IN
      * @returns {void}.
      */
     triggerShapeChanged(shapeChangedArgs: ShapeChangeEventArgs): void;
+    private triggerActionComplete;
 }