@syncfusion/ej2-image-editor 21.2.6 → 22.1.34

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

@@ -0,0 +1,189 @@
+/**
+ * An enum representing the file types supported by the image editor.
+ *
+ * @enum {string}
+ */
+export declare enum FileType {
+    /** The PNG file type. */
+    Png = "Png",
+    /** The JPEG file type. */
+    Jpeg = "Jpeg",
+    /** The SVG file type. */
+    Svg = "Svg"
+}
+/**
+ * An enumeration representing the direction of an image editor operation.
+ *
+ * @enum {string}
+ */
+export declare enum Direction {
+    /** The horizontal direction. */
+    Horizontal = "Horizontal",
+    /** The vertical direction. */
+    Vertical = "Vertical"
+}
+/**
+ * An enumeration representing the type of shape to be added in the image editor.
+ *
+ * @enum {string}
+ */
+export declare enum ShapeType {
+    /** A rectangle shape. */
+    Rectangle = "Rectangle",
+    /** An ellipse shape. */
+    Ellipse = "Ellipse",
+    /** A line shape. */
+    Line = "Line",
+    /** An arrow shape. */
+    Arrow = "Arrow",
+    /** A path shape. */
+    Path = "Path",
+    /** A text shape. */
+    Text = "Text",
+    /** A freehand drawing shape. */
+    FreehandDraw = "FreehandDraw"
+}
+/**
+ * An enumeration representing the different ways to trigger zooming in the image editor.
+ *
+ * @aspNumberEnum
+ */
+export declare enum ZoomTrigger {
+    /** Zooming triggered by mouse wheel. */
+    MouseWheel = 1,
+    /** Zooming triggered by pinch gesture. */
+    Pinch = 2,
+    /** Zooming triggered by command keys. */
+    Commands = 4,
+    /** Zooming triggered by toolbar button click. */
+    Toolbar = 8
+}
+/**
+ * * An enum representing the available themes in the image editor.
+ */
+export declare enum Theme {
+    /** The Bootstrap 5 theme. */
+    Bootstrap5 = "Bootstrap5",
+    /** The dark variant of the Bootstrap 5 theme. */
+    Bootstrap5Dark = "Bootstrap5Dark",
+    /** The Tailwind CSS theme. */
+    Tailwind = "Tailwind",
+    /** The dark variant of the Tailwind CSS theme. */
+    TailwindDark = "TailwindDark",
+    /** The Fluent UI theme. */
+    Fluent = "Fluent",
+    /** The dark variant of the Fluent UI theme. */
+    FluentDark = "FluentDark",
+    /** The Bootstrap 4 theme. */
+    Bootstrap4 = "Bootstrap4",
+    /** The Bootstrap theme. */
+    Bootstrap = "Bootstrap",
+    /** The dark variant of the Bootstrap theme. */
+    BootstrapDark = "BootstrapDark",
+    /** The Material Design theme. */
+    Material = "Material",
+    /** The dark variant of the Material Design theme. */
+    MaterialDark = "MaterialDark",
+    /** The Fabric theme. */
+    Fabric = "Fabric",
+    /** The dark variant of the Fabric theme. */
+    FabricDark = "FabricDark",
+    /** The high contrast theme. */
+    Highcontrast = "Highcontrast"
+}
+/**
+ * An enum representing the available toolbar commands in the image editor.
+ */
+export declare enum ImageEditorCommand {
+    Crop = "Crop",
+    Transform = "Transform",
+    Annotate = "Annotate",
+    ZoomIn = "ZoomIn",
+    ZoomOut = "ZoomOut",
+    Open = "Open",
+    Reset = "Reset",
+    Save = "Save",
+    Pan = "Pan",
+    Move = "Move",
+    Pen = "Pen",
+    Line = "Line",
+    Arrow = "Arrow",
+    Path = "Path",
+    Rectangle = "Rectangle",
+    Ellipse = "Ellipse",
+    Text = "Text",
+    CustomSelection = "CustomSelection",
+    CircleSelection = "CircleSelection",
+    SquareSelection = "SquareSelection",
+    RatioSelection = "RatioSelection",
+    RotateLeft = "RotateLeft",
+    RotateRight = "RotateRight",
+    FlipHorizontal = "FlipHorizontal",
+    FlipVertical = "FlipVertical"
+}
+/**
+ * An enumeration of available image filter options.
+ *
+ * @remarks
+ * These options can be used with the `applyImageFilter` method of the image editor control to apply filters to an image.
+ */
+export declare enum ImageFilterOption {
+    /** Default filter */
+    Default = "Default",
+    /** Chrome filter */
+    Chrome = "Chrome",
+    /** Cold filter */
+    Cold = "Cold",
+    /** Warm filter */
+    Warm = "Warm",
+    /** Grayscale filter */
+    Grayscale = "Grayscale",
+    /** Sepia filter */
+    Sepia = "Sepia",
+    /** Invert filter */
+    Invert = "Invert"
+}
+/**
+ * An enumeration of available image finetune options.
+ *
+ * @remarks
+ * These options can be used with the `finetuneImage` method of the image editor control to apply finetuning to an image.
+ */
+export declare enum ImageFinetuneOption {
+    /** Adjust the brightness of the image */
+    Brightness = "Brightness",
+    /** Adjust the contrast of the image */
+    Contrast = "Contrast",
+    /** Adjust the hue of the image */
+    Hue = "Hue",
+    /** Adjust the saturation of the image */
+    Saturation = "Saturation",
+    /** Adjust the exposure of the image */
+    Exposure = "Exposure",
+    /** Adjust the opacity of the image */
+    Opacity = "Opacity",
+    /** Adjust the blur of the image */
+    Blur = "Blur"
+}
+/**
+ * Specifies the type of arrowhead should be drawn.
+ *
+ */
+export declare enum ArrowheadType {
+    /** Indicates no arrowhead should be drawn. */
+    None = "None",
+    /** Indicates a normal triangle-shaped arrowhead should be drawn. */
+    Arrow = "Arrow",
+    /** Indicates a solid triangle-shaped arrowhead should be drawn. */
+    SolidArrow = "SolidArrow",
+    /** Indicates a circular-shaped arrowhead should be drawn. */
+    Circle = "Circle",
+    /** Indicates a solid circular-shaped arrowhead should be drawn. */
+    SolidCircle = "SolidCircle",
+    /** Indicates a square-shaped arrowhead should be drawn. */
+    Square = "Square",
+    /** Indicates a solid square-shaped arrowhead should be drawn. */
+    SolidSquare = "SolidSquare",
+    /** Indicates a bar shaped arrowhead should be drawn. */
+    Bar = "Bar"
+}

package/src/image-editor/base/enum.js

@@ -0,0 +1,198 @@
+/**
+ * An enum representing the file types supported by the image editor.
+ *
+ * @enum {string}
+ */
+export var FileType;
+(function (FileType) {
+    /** The PNG file type. */
+    FileType["Png"] = "Png";
+    /** The JPEG file type. */
+    FileType["Jpeg"] = "Jpeg";
+    /** The SVG file type. */
+    FileType["Svg"] = "Svg";
+})(FileType || (FileType = {}));
+/**
+ * An enumeration representing the direction of an image editor operation.
+ *
+ * @enum {string}
+ */
+export var Direction;
+(function (Direction) {
+    /** The horizontal direction. */
+    Direction["Horizontal"] = "Horizontal";
+    /** The vertical direction. */
+    Direction["Vertical"] = "Vertical";
+})(Direction || (Direction = {}));
+/**
+ * An enumeration representing the type of shape to be added in the image editor.
+ *
+ * @enum {string}
+ */
+export var ShapeType;
+(function (ShapeType) {
+    /** A rectangle shape. */
+    ShapeType["Rectangle"] = "Rectangle";
+    /** An ellipse shape. */
+    ShapeType["Ellipse"] = "Ellipse";
+    /** A line shape. */
+    ShapeType["Line"] = "Line";
+    /** An arrow shape. */
+    ShapeType["Arrow"] = "Arrow";
+    /** A path shape. */
+    ShapeType["Path"] = "Path";
+    /** A text shape. */
+    ShapeType["Text"] = "Text";
+    /** A freehand drawing shape. */
+    ShapeType["FreehandDraw"] = "FreehandDraw";
+})(ShapeType || (ShapeType = {}));
+/**
+ * An enumeration representing the different ways to trigger zooming in the image editor.
+ *
+ * @aspNumberEnum
+ */
+export var ZoomTrigger;
+(function (ZoomTrigger) {
+    /** Zooming triggered by mouse wheel. */
+    ZoomTrigger[ZoomTrigger["MouseWheel"] = 1] = "MouseWheel";
+    /** Zooming triggered by pinch gesture. */
+    ZoomTrigger[ZoomTrigger["Pinch"] = 2] = "Pinch";
+    /** Zooming triggered by command keys. */
+    ZoomTrigger[ZoomTrigger["Commands"] = 4] = "Commands";
+    /** Zooming triggered by toolbar button click. */
+    ZoomTrigger[ZoomTrigger["Toolbar"] = 8] = "Toolbar";
+})(ZoomTrigger || (ZoomTrigger = {}));
+/**
+ * * An enum representing the available themes in the image editor.
+ */
+export var Theme;
+(function (Theme) {
+    /** The Bootstrap 5 theme. */
+    Theme["Bootstrap5"] = "Bootstrap5";
+    /** The dark variant of the Bootstrap 5 theme. */
+    Theme["Bootstrap5Dark"] = "Bootstrap5Dark";
+    /** The Tailwind CSS theme. */
+    Theme["Tailwind"] = "Tailwind";
+    /** The dark variant of the Tailwind CSS theme. */
+    Theme["TailwindDark"] = "TailwindDark";
+    /** The Fluent UI theme. */
+    Theme["Fluent"] = "Fluent";
+    /** The dark variant of the Fluent UI theme. */
+    Theme["FluentDark"] = "FluentDark";
+    /** The Bootstrap 4 theme. */
+    Theme["Bootstrap4"] = "Bootstrap4";
+    /** The Bootstrap theme. */
+    Theme["Bootstrap"] = "Bootstrap";
+    /** The dark variant of the Bootstrap theme. */
+    Theme["BootstrapDark"] = "BootstrapDark";
+    /** The Material Design theme. */
+    Theme["Material"] = "Material";
+    /** The dark variant of the Material Design theme. */
+    Theme["MaterialDark"] = "MaterialDark";
+    /** The Fabric theme. */
+    Theme["Fabric"] = "Fabric";
+    /** The dark variant of the Fabric theme. */
+    Theme["FabricDark"] = "FabricDark";
+    /** The high contrast theme. */
+    Theme["Highcontrast"] = "Highcontrast";
+})(Theme || (Theme = {}));
+/**
+ * An enum representing the available toolbar commands in the image editor.
+ */
+export var ImageEditorCommand;
+(function (ImageEditorCommand) {
+    ImageEditorCommand["Crop"] = "Crop";
+    ImageEditorCommand["Transform"] = "Transform";
+    ImageEditorCommand["Annotate"] = "Annotate";
+    ImageEditorCommand["ZoomIn"] = "ZoomIn";
+    ImageEditorCommand["ZoomOut"] = "ZoomOut";
+    ImageEditorCommand["Open"] = "Open";
+    ImageEditorCommand["Reset"] = "Reset";
+    ImageEditorCommand["Save"] = "Save";
+    ImageEditorCommand["Pan"] = "Pan";
+    ImageEditorCommand["Move"] = "Move";
+    ImageEditorCommand["Pen"] = "Pen";
+    ImageEditorCommand["Line"] = "Line";
+    ImageEditorCommand["Arrow"] = "Arrow";
+    ImageEditorCommand["Path"] = "Path";
+    ImageEditorCommand["Rectangle"] = "Rectangle";
+    ImageEditorCommand["Ellipse"] = "Ellipse";
+    ImageEditorCommand["Text"] = "Text";
+    ImageEditorCommand["CustomSelection"] = "CustomSelection";
+    ImageEditorCommand["CircleSelection"] = "CircleSelection";
+    ImageEditorCommand["SquareSelection"] = "SquareSelection";
+    ImageEditorCommand["RatioSelection"] = "RatioSelection";
+    ImageEditorCommand["RotateLeft"] = "RotateLeft";
+    ImageEditorCommand["RotateRight"] = "RotateRight";
+    ImageEditorCommand["FlipHorizontal"] = "FlipHorizontal";
+    ImageEditorCommand["FlipVertical"] = "FlipVertical";
+})(ImageEditorCommand || (ImageEditorCommand = {}));
+/**
+ * An enumeration of available image filter options.
+ *
+ * @remarks
+ * These options can be used with the `applyImageFilter` method of the image editor control to apply filters to an image.
+ */
+export var ImageFilterOption;
+(function (ImageFilterOption) {
+    /** Default filter */
+    ImageFilterOption["Default"] = "Default";
+    /** Chrome filter */
+    ImageFilterOption["Chrome"] = "Chrome";
+    /** Cold filter */
+    ImageFilterOption["Cold"] = "Cold";
+    /** Warm filter */
+    ImageFilterOption["Warm"] = "Warm";
+    /** Grayscale filter */
+    ImageFilterOption["Grayscale"] = "Grayscale";
+    /** Sepia filter */
+    ImageFilterOption["Sepia"] = "Sepia";
+    /** Invert filter */
+    ImageFilterOption["Invert"] = "Invert";
+})(ImageFilterOption || (ImageFilterOption = {}));
+/**
+ * An enumeration of available image finetune options.
+ *
+ * @remarks
+ * These options can be used with the `finetuneImage` method of the image editor control to apply finetuning to an image.
+ */
+export var ImageFinetuneOption;
+(function (ImageFinetuneOption) {
+    /** Adjust the brightness of the image */
+    ImageFinetuneOption["Brightness"] = "Brightness";
+    /** Adjust the contrast of the image */
+    ImageFinetuneOption["Contrast"] = "Contrast";
+    /** Adjust the hue of the image */
+    ImageFinetuneOption["Hue"] = "Hue";
+    /** Adjust the saturation of the image */
+    ImageFinetuneOption["Saturation"] = "Saturation";
+    /** Adjust the exposure of the image */
+    ImageFinetuneOption["Exposure"] = "Exposure";
+    /** Adjust the opacity of the image */
+    ImageFinetuneOption["Opacity"] = "Opacity";
+    /** Adjust the blur of the image */
+    ImageFinetuneOption["Blur"] = "Blur";
+})(ImageFinetuneOption || (ImageFinetuneOption = {}));
+/**
+ * Specifies the type of arrowhead should be drawn.
+ *
+ */
+export var ArrowheadType;
+(function (ArrowheadType) {
+    /** Indicates no arrowhead should be drawn. */
+    ArrowheadType["None"] = "None";
+    /** Indicates a normal triangle-shaped arrowhead should be drawn. */
+    ArrowheadType["Arrow"] = "Arrow";
+    /** Indicates a solid triangle-shaped arrowhead should be drawn. */
+    ArrowheadType["SolidArrow"] = "SolidArrow";
+    /** Indicates a circular-shaped arrowhead should be drawn. */
+    ArrowheadType["Circle"] = "Circle";
+    /** Indicates a solid circular-shaped arrowhead should be drawn. */
+    ArrowheadType["SolidCircle"] = "SolidCircle";
+    /** Indicates a square-shaped arrowhead should be drawn. */
+    ArrowheadType["Square"] = "Square";
+    /** Indicates a solid square-shaped arrowhead should be drawn. */
+    ArrowheadType["SolidSquare"] = "SolidSquare";
+    /** Indicates a bar shaped arrowhead should be drawn. */
+    ArrowheadType["Bar"] = "Bar";
+})(ArrowheadType || (ArrowheadType = {}));