HelpBot Assistant

How can I help you?

ES5 getting started in EJ2 JavaScript Image Editor control

10 Feb 202610 minutes to read

This section explains the steps required to create a simple Essential® JS 2 Image Editor and demonstrate the basic usage of the Image Editor control in a JavaScript application.

Dependencies

The list of dependencies required to use the Image Editor component in your application is given below:

|-- @syncfusion/ej2-image-editor
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-buttons
    |-- @syncfusion/ej2-dropdowns
    |-- @syncfusion/ej2-inputs
    |-- @syncfusion/ej2-navigations
    |-- @syncfusion/ej2-popups
    |-- @syncfusion/ej2-splitbuttons

Setup for local environment

Refer to the following steps to set up your local environment.

Step 1: Create a root folder named my-app for your application.

Step 2: Create a my-app/resources folder to store local scripts and styles files.

Step 3: Open Visual Studio Code and create my-app/index.js and my-app/index.html files to initialize the Essential® JS 2 Image Editor control.

Adding Syncfusion® resources

The Essential® JS 2 Image Editor control can be initialized by using either of the following ways.

  • Using local script and style.
  • Using CDN link for script and style.

Using local script and style references in a HTML page

Step 1: Create an app folder quickstart for getting started.

Step 2: You can get the global scripts and styles from the Essential Studio® JavaScript (Essential® JS 2) build installed location.

Syntax:

Dependency Script: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{DEPENDENCY_PACKAGE_NAME}\dist\global\{DEPENDENCY_PACKAGE_NAME}.min.js

Control Script: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{PACKAGE_NAME}\dist\global\{PACKAGE_NAME}.min.js

Dependency Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{DEPENDENCY_PACKAGE_NAME}\styles\material.css

Control Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{PACKAGE_NAME}\styles\material.css

Example:

Dependency Script: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-base\dist\global\ej2-base.min.js

Control Script: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-image-editor\dist\global\ej2-image-editor.min.js

Dependency Styles: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-base\styles\material.css

Control Styles: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-image-editor\styles\material.css

The below located script and style file contains all Syncfusion® JavaScript (ES5) UI control resources in a single file.

Scripts: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\ej2\dist\ej2.min.js

Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\ej2\material.css

The Custom Resource Generator (CRG) is an online web tool, which can be used to generate the custom script and styles for a set of specific controls. This web tool is useful to combine the required control scripts and styles in a single file.

Step 3: Create a folder ~/quickstart/resources and copy/paste the global scripts and styles from the above installed location to quickstart/resources/package corresponding package location.

Step 4: Create a HTML page (index.html) in ~/quickstart/index.html location and add the Essential® JS 2 script and style references.

<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
       <head>
          <title>Essential JS 2 - Image Editor</title>
          <!-- Essential JS 2 Image Editor's dependent material theme -->
          <link href="resources/base/material.css" rel="stylesheet" type="text/css"/>
          <link href="resources/buttons/material.css" rel="stylesheet" type="text/css"/>
          <link href="resources/inputs/material.css" rel="stylesheet" type="text/css"/>
          <link href="resources/navigations/material.css" rel="stylesheet" type="text/css"/>
          <link href="resources/popups/material.css" rel="stylesheet" type="text/css"/>
          <link href="resources/splitbuttons/material.css" rel="stylesheet" type="text/css"/>

          <!-- Essential JS 2 Image Editor's control material theme -->
          <link href="resources/image-editor/material.css" rel="stylesheet" type="text/css"/>

          <!-- Essential JS 2 Image Editor's dependent global script -->
          <script src="resources/base/ej2-base.min.js" type="text/javascript"></script>
          <script src="resources/buttons/ej2-buttons.min.js" type="text/javascript"></script>
          <script src="resources/inputs/ej2-inputs.min.js" type="text/javascript"></script>
          <script src="resources/navigations/ej2-navigations.min.js" type="text/javascript"></script>
          <script src="resources/popups/ej2-popups.min.js" type="text/javascript"></script>
          <script src="resources/splitbuttons/ej2-splitbuttons.min.js" type="text/javascript"></script>

          <!-- Essential JS 2 Image Editor's control global script -->
          <script src="resources/image-editor/ej2-image-editor.min.js" type="text/javascript"></script>
       </head>
       <body>
       </body>
  </html>

Step 5: Now, add the Image Editor element and initiate the Syncfusion® JavaScript Image Editor control in the index.html by using following code

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
    <title>Essential JS 2 - Image Editor</title>
    <!-- Essential JS 2 Image Editor's dependent material theme -->
    <link href="resources/base/material.css" rel="stylesheet" type="text/css"/>
    <link href="resources/buttons/material.css" rel="stylesheet" type="text/css"/>
    <link href="resources/inputs/material.css" rel="stylesheet" type="text/css"/>
    <link href="resources/navigations/material.css" rel="stylesheet" type="text/css"/>
    <link href="resources/popups/material.css" rel="stylesheet" type="text/css"/>
    <link href="resources/splitbuttons/material.css" rel="stylesheet" type="text/css"/>

    <!-- Essential JS 2 Image Editor's control material theme -->
    <link href="resources/image-editor/material.css" rel="stylesheet" type="text/css"/>

    <!-- Essential JS 2 Image Editor's dependent global script -->
    <script src="resources/base/ej2-base.min.js" type="text/javascript"></script>
    <script src="resources/buttons/ej2-buttons.min.js" type="text/javascript"></script>
    <script src="resources/inputs/ej2-inputs.min.js" type="text/javascript"></script>
    <script src="resources/navigations/ej2-navigations.min.js" type="text/javascript"></script>
    <script src="resources/popups/ej2-popups.min.js" type="text/javascript"></script>
    <script src="resources/splitbuttons/ej2-splitbuttons.min.js" type="text/javascript"></script>

    <!-- Essential JS 2 Image Editor's control global script -->
    <script src="resources/image-editor/ej2-image-editor.min.js" type="text/javascript"></script>
</head>

<body>
    <!--element which is going to render-->
     <div id="imageeditor"></div>

    <script>
        //Image Editor items definition
        this.default = function() {
            new ej.imageeditor.ImageEditor({
            width: '800px',
            height: '600px',
            }, '#imageeditor');
        };
    </script>
</body>

</html>

Step 6: Now, run the index.html in web browser, it will render the Syncfusion® JavaScript Image Editor control.

Step 1: Create an app folder quickstart for getting started.

Step 2: The Essential® JS 2 control’s global scripts and styles are already hosted in the below CDN link formats.

Syntax:

Dependency Script: https://cdn.syncfusion.com/ej2/{DEPENDENCY_PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Control Script: https://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Dependency Styles: https://cdn.syncfusion.com/ej2/{DEPENDENCY_PACKAGE_NAME}/styles/material.css

Control Styles: https://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/styles/material.css

Example:

Script: https://cdn.syncfusion.com/ej2/ej2-image-editor/dist/global/ej2-image-editor.min.js

Styles: https://cdn.syncfusion.com/ej2/ej2-image-editor/styles/material.css

Step 3: Create a HTML page (index.html) in ~/quickstart/index.html location and add the CDN link references. Now, add the Image Editor element and initiate the Syncfusion® JavaScript Image Editor control in the index.html by using following code.

Step 4: Now, run the index.html in web browser, it will render the Syncfusion® JavaScript Image Editor control.

Add the Image Editor control to the application

Add an HTML DIV element with the id attribute set to image editor in your index.html file:

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
                
<title>Essential JS 2 - Image Editor</title>

<!-- Essential JS 2 Image Editor's dependent material theme -->
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/styles/material.css" rel="stylesheet" type="text/css" />
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-buttons/styles/material.css" rel="stylesheet" type="text/css" />
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-inputs/styles/material.css" rel="stylesheet" type="text/css" />
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-lists/styles/material.css" rel="stylesheet" type="text/css" />
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-navigations/styles/material.css" rel="stylesheet" type="text/css" />
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-popups/styles/material.css" rel="stylesheet" type="text/css" />
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-splitbuttons/styles/material.css" rel="stylesheet" type="text/css" />

<!-- Essential JS 2 Image Editor's material theme -->
<link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-image-editor/styles/material.css" rel="stylesheet" type="text/css" />

<!-- Essential JS 2 Image Editor's dependent scripts -->
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/dist/global/ej2-data.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-navigations/dist/global/ej2-navigations.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-splitbuttons/dist/global/ej2-splitbuttons.min.js" type="text/javascript"></script>

<!-- Essential JS 2 Image Editor's global script -->
<script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-image-editor/dist/global/ej2-image-editor.min.js" type="text/javascript"></script>

<!--style reference from app-->
<link href="styles.css" rel="stylesheet" />
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>

<body>
<!--element which is going to render-->
<div id="imageeditor">
</div>

<script>
    new  ej.imageeditor.ImageEditor({
    width: '550px',
    height: '350px',
    }, '#imageeditor');
</script>
</body>

</html>