Skip to content

Commit b966db3

Browse files
rparthi-pdfrparthi-pdf
authored
Merge pull request #24 from SyncfusionExamples/EJ2-380623-exportImport
380623: Samples for Export and Import Annotation
2 parents 88de3c7 + e482c10 commit b966db3

File tree

13 files changed

+341
-0
lines changed

13 files changed

+341
-0
lines changed

‎How to/Export and Import Annotation/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist/
2+
node_modules/

‎How to/Export and Import Annotation/README.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Essential® JS 2 QuickStart
2+
3+
This project is a skeleton application used to create [Essential® JS 2](https://www.syncfusion.com/products/essential-js2) web application.
4+
5+
>This application uses the latest version of the [webpack-cli](https://webpack.js.org/api/cli/#commands). It requires node `v14.15.0` or higher.
6+
7+
## Getting Started
8+
9+
To get started you need to clone the `ej2-quickstart` repository and navigate to `ej2-quickstart` location.
10+
11+
```
12+
git clone https://github.com/syncfusion/ej2-quickstart.git quickstart
13+
cd quickstart
14+
```
15+
16+
## Installing
17+
18+
We can get all the Essential® JS 2 components in a single npm package [`ej2`](https://www.npmjs.com/package/@syncfusion/ej2).
19+
20+
We already configure the required packages in the `package.json` file.
21+
22+
You can run the below command to install all dependent packages related to this seed project.
23+
24+
```
25+
npm install
26+
```
27+
28+
## Testing
29+
30+
This application is preconfigured with End-to-End testing and the test case is written in Jasmine.
31+
32+
We run the test scripts with [Protractor](http://www.protractortest.org/#/) end-to-end test runner. The test case file can be found in the `e2e` folder.
33+
34+
Protractor can interact with our web application and verify the test scripts.
35+
36+
We have to install WebDriver and also need to ensure it is updated. Open a separate terminal and run the below npm script.
37+
38+
```
39+
npm run update-webdriver
40+
```
41+
42+
Open another terminal and run the below npm script. It will start web server to serve our application.
43+
44+
```
45+
npm run serve
46+
```
47+
48+
Once the web server is up and running, we can run the end-to-end tests using the below npm script
49+
50+
```
51+
npm run test
52+
```
53+
54+
> **Note:** Since Protractor is using the Selenium Standalone Server, the Java Development Kit (JDK) need to be installed in your local machine.
55+
56+
If JDK is not installed in your local machine, you can download it from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
57+
58+
## Running
59+
60+
The application is configured with [webpack-dev-server](https://webpack.js.org/configuration/dev-server/#devserver), so it will serve the web application in your default browser.
61+
62+
We have used [Webpack](https://github.com/webpack/webpack) for module loading.
63+
64+
You can use the below npm script to run the web application.
65+
66+
```
67+
npm run start
68+
```
69+
70+
## Resources
71+
72+
You can also refer the below resources to know more details about Essential® JS 2 components.
73+
74+
* [Pure JS Demos](http://ej2.syncfusion.com/demos/)
75+
* [Pure JS Documentation](http://ej2.syncfusion.com/documentation/)

‎How to/Export and Import Annotation/e2e/index.spec.js

Whitespace-only changes.

‎How to/Export and Import Annotation/e2e/protractor.conf.js

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
exports.config = {
2+
3+
allScriptsTimeout: 11000,
4+
5+
capabilities: {
6+
'browserName': 'chrome'
7+
},
8+
9+
framework: 'jasmine',
10+
11+
jasmineNodeOpts: {
12+
defaultTimeoutInterval: 10000
13+
},
14+
directConnect: true,
15+
16+
onPrepare: function() {
17+
browser.waitForAngularEnabled(false);
18+
},
19+
20+
specs: ['./*.spec.js']
21+
};

‎How to/Export and Import Annotation/gulpfile.js

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
var gulp = require('gulp');
4+
5+
/**
6+
* Compile TypeScript to JS
7+
*/
8+
gulp.task('compile', function (done) {
9+
var webpack = require('webpack');
10+
var webpackStream = require('webpack-stream');
11+
gulp.src(['./src/app/app.ts']).pipe(webpackStream({
12+
config: require('./webpack.config.js')
13+
}, webpack))
14+
.pipe(gulp.dest('./dist'))
15+
.on('end', function () {
16+
done();
17+
});
18+
});
19+
20+
/**
21+
* Testing spec files
22+
*/
23+
var protractor = require('gulp-protractor').protractor;
24+
var webdriver_standalone = require('gulp-protractor').webdriver_standalone;
25+
var webdriver_update = require('gulp-protractor').webdriver_update_specific;
26+
27+
gulp.task('e2e-serve', webdriver_standalone);
28+
29+
gulp.task('e2e-webdriver-update', webdriver_update({
30+
webdriverManagerArgs: ['--ie', '--edge']
31+
}));
32+
33+
gulp.task('e2e-test', gulp.series('compile', function (done) {
34+
var browserSync = require('browser-sync');
35+
var bs = browserSync.create('Essential JS 2');
36+
var options = {
37+
server: {
38+
baseDir: [
39+
'./dist/',
40+
],
41+
directory: true
42+
},
43+
ui: false,
44+
open: false,
45+
notify: false
46+
};
47+
bs.init(options, function () {
48+
gulp.src(['./spec/**/*.spec.js'])
49+
.pipe(protractor({
50+
configFile: 'e2e/protractor.conf.js'
51+
}))
52+
.on('error', function (e) {
53+
console.error('Error: ' + e.message);
54+
done();
55+
process.exit(1);
56+
})
57+
.on('end', function () {
58+
done();
59+
process.exit(0);
60+
});
61+
});
62+
}));

‎How to/Export and Import Annotation/license

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Essential® JS 2 library is available under the Syncfusion® Essential Studio® program, and can be licensed either under the Syncfusion® Community License Program or the Syncfusion® commercial license.
2+
3+
To be qualified for the Syncfusion® Community License Program you must have a gross revenue of less than one (1) million U.S. dollars ($1,000,000.00 USD) per year and have less than five (5) developers in your organization, and agree to be bound by Syncfusion’s terms and conditions.
4+
5+
Customers who do not qualify for the community license can contact [email protected] for commercial licensing options.
6+
7+
Under no circumstances can you use this product without (1) either a Community License or a commercial license and (2) without agreeing and abiding by Syncfusion’s license containing all terms and conditions.
8+
9+
The Syncfusion® license that contains the terms and conditions can be found at
10+
https://www.syncfusion.com/content/downloads/syncfusion_license.pdf

‎How to/Export and Import Annotation/package.json

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "ej2-quickstart",
3+
"version": "0.0.1",
4+
"description": "Essential JS 2 typescript quick start application",
5+
"author": "Syncfusion Inc.",
6+
"license": "SEE LICENSE IN license",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/syncfusion/ej2-quickstart.git"
10+
},
11+
"scripts": {
12+
"start": "webpack-dev-server --mode development",
13+
"build": "webpack --mode production",
14+
"serve": "gulp e2e-serve",
15+
"test": "gulp e2e-test",
16+
"update-webdriver": "gulp e2e-webdriver-update"
17+
},
18+
"devDependencies": {
19+
"ajv": "^8.11.2",
20+
"browser-sync": "^2.18.12",
21+
"gulp": "*",
22+
"typescript": "*",
23+
"gulp-protractor": "*",
24+
"gulp-typescript": "*",
25+
"jasmine": "^2.6.0",
26+
"css-loader": "^6.7.2",
27+
"ts-loader": "^9.4.1",
28+
"mini-css-extract-plugin": "^2.7.0",
29+
"html-webpack-plugin": "^5.5.0",
30+
"webpack": "^5.75.0",
31+
"webpack-cli": "^5.0.0",
32+
"webpack-dev-server": "^4.11.1",
33+
"webpack-stream": "^7.0.0"
34+
},
35+
"dependencies": {
36+
"@syncfusion/ej2": "*"
37+
}
38+
}

‎How to/Export and Import Annotation/src/app/app.ts

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import { PdfViewer, Toolbar, Magnification, Navigation, Annotation, LinkAnnotation, ThumbnailView, BookmarkView, TextSelection, TextSearch, FormFields, FormDesigner} from '@syncfusion/ej2-pdfviewer';
2+
3+
PdfViewer.Inject(Toolbar, Magnification, Navigation, Annotation, LinkAnnotation, ThumbnailView, BookmarkView, TextSelection, TextSearch, FormFields, FormDesigner);
4+
5+
let pdfviewer: PdfViewer = new PdfViewer();
6+
pdfviewer.documentPath = "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf";
7+
pdfviewer.resourceUrl = "https://cdn.syncfusion.com/ej2/27.1.48/dist/ej2-pdfviewer-lib";
8+
9+
pdfviewer.appendTo('#PdfViewer');
10+
11+
enum AnnotationDataFormat {
12+
Json = 'Json',
13+
Xfdf = 'Xfdf'
14+
}
15+
16+
let ExportXfdf = document.getElementById('ExportXfdf');
17+
if (ExportXfdf) {
18+
ExportXfdf.addEventListener('click', function () {
19+
// export the annotation in XFDF format.
20+
pdfviewer.exportAnnotation(AnnotationDataFormat.Xfdf);
21+
});
22+
}
23+
24+
let ExportJSON = document.getElementById('ExportJSON');
25+
if (ExportJSON) {
26+
ExportJSON.addEventListener('click', function () {
27+
// export the annotation in JSON format.
28+
pdfviewer.exportAnnotation(AnnotationDataFormat.Json);
29+
});
30+
}
31+
let exportObject: any;
32+
let ExportAnnotationsAsObject = document.getElementById('export');
33+
//Export annotation as object.
34+
if (ExportAnnotationsAsObject) {
35+
ExportAnnotationsAsObject.addEventListener('click', () => {
36+
pdfviewer.exportAnnotationsAsObject().then(function (value: any) {
37+
exportObject = value;
38+
});
39+
});
40+
}
41+
42+
let Import = document.getElementById('import');
43+
//Import annotation that are exported as object.
44+
if (Import) {
45+
Import.addEventListener('click', () => {
46+
pdfviewer.importAnnotation(JSON.parse(exportObject));
47+
});
48+
}

‎How to/Export and Import Annotation/src/index.html

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
4+
<head>
5+
<title>Essential JS 2</title>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
8+
<meta name="description" content="Essential JS 2" />
9+
<meta name="author" content="Syncfusion" />
10+
<link rel="shortcut icon" href="resources/favicon.ico" />
11+
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
12+
</head>
13+
14+
<body>
15+
<button id="ExportXfdf">ExportXfdf</button>
16+
<button id="ExportJSON">ExportJSON</button>
17+
<button id="export">ExportasObject</button>
18+
<button id="import">Import</button>
19+
<!--Element which will render as PDF Viewer -->
20+
<div id="PdfViewer"></div>
21+
</body>
22+
23+
</html>

‎How to/Export and Import Annotation/src/resources/favicon.ico

6.42 KB
Binary file not shown.

‎How to/Export and Import Annotation/src/styles/styles.css

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@import '../../node_modules/@syncfusion/ej2-base/styles/material.css';
2+
@import '../../node_modules/@syncfusion/ej2-buttons/styles/material.css';
3+
@import '../../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
4+
@import '../../node_modules/@syncfusion/ej2-inputs/styles/material.css';
5+
@import '../../node_modules/@syncfusion/ej2-navigations/styles/material.css';
6+
@import '../../node_modules/@syncfusion/ej2-popups/styles/material.css';
7+
@import '../../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
8+
@import "../../node_modules/@syncfusion/ej2-pdfviewer/styles/material.css";
9+
@import "../../node_modules/@syncfusion/ej2-notifications/styles/material.css";

‎How to/Export and Import Annotation/tsconfig.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"compilerOptions": {
3+
"target": "es2016",
4+
"module": "ES6",
5+
"sourceMap": true,
6+
"esModuleInterop": true,
7+
"forceConsistentCasingInFileNames": true,
8+
"strict": true,
9+
"skipLibCheck": true,
10+
"moduleResolution": "node"
11+
}
12+
}

‎How to/Export and Import Annotation/webpack.config.js

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
const HtmlWebpackPlugin = require("html-webpack-plugin");
2+
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
3+
const path = require('path');
4+
5+
module.exports = {
6+
entry: ['./src/app/app.ts', './src/styles/styles.css'],
7+
module: {
8+
rules: [
9+
{
10+
test: /\.ts?$/,
11+
use: 'ts-loader',
12+
exclude: /node_modules/,
13+
},
14+
{
15+
test: /\.css$/,
16+
use: [ MiniCssExtractPlugin.loader, "css-loader" ]
17+
},
18+
],
19+
},
20+
resolve: {
21+
extensions: ['.ts', '.js'],
22+
},
23+
output: {
24+
filename: 'bundle.js',
25+
path: path.resolve(__dirname, 'dist'),
26+
},
27+
plugins: [
28+
new HtmlWebpackPlugin({
29+
template: 'src/index.html'
30+
}),
31+
new MiniCssExtractPlugin({
32+
filename: "bundle.css"
33+
})
34+
],
35+
devServer: {
36+
static: path.join(__dirname, "dist"),
37+
compress: true,
38+
port: 4000,
39+
open: true
40+
},
41+
};

0 commit comments

Comments
 (0)