1038023: Annotations Revamp in Vue PDF Viewer

Document-Processing-toc.html

@@ -1713,20 +1713,54 @@
 							</li>
 							<li>Annotation
 								<ul>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/text-markup-annotation">Text Markup Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/shape-annotation">Shape Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/stamp-annotation">Stamp Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/signature-annotation">Hand Written Signature</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/sticky-notes-annotation">Sticky Notes Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/measurement-annotation">Measurement Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/free-text-annotation">Free Text Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/ink-annotation">Ink Annotation</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/line-angle-constraints">Line Angle Constraints</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/overview">Overview</a></li>
+									<li>Annotation Types
+										<ul>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/highlight-annotation">Highlight Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/Squiggly-annotation">Squiggly Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/underline-annotation">Underline Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/strikethrough-annotation">Strikethrough Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/line-annotation">Line Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/arrow-annotation">Arrow Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/rectangle-annotation">Rectangle Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/circle-annotation">Circle Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/polygon-annotation">Polygon Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/free-text-annotation">Free Text Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/ink-annotation">Ink Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/stamp-annotation">Stamp Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/sticky-notes">Sticky Notes Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/redaction-annotation">Redaction Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/distance-annotation">Distance Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/perimeter-annotation">Perimeter Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/area-annotation">Area Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/radius-annotation">Radius Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-types/volume-annotation">Volume Annotation</a></li>
+										</ul>
+									</li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/toolbar-customization/annotation-toolbar">Annotation Toolbar</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/create-modify-annotation">Create and modify Annotation</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/customize-annotation">Customize Annotation</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/delete-annotation">Remove Annotation</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotations-undo-redo">Undo or Redo Annotation Changes</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-permission">Annotation Permission</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/signature-annotation">Handwritten Signature</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/line-angle-constraints">Line Angle Constraint</a></li>
 									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-comment-filter">Annotation Comments Filter</a></li>
 									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/ink-eraser">Ink Eraser</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-event">Annotations Events</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotations-in-mobile-view">Annotations in Mobile View</a></li>
-									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/comments">Comments</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/custom-data">Adding custom Data in annotations</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/flatten-annotation">Flatten Annotations</a></li>
+									<li>Export and Import annotations
+										<ul>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/export-import/export-annotation">Export Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/export-import/import-annotation">Import Annotation</a></li>
+											<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/export-import/export-import-events">Export and Import Events</a></li>
+										</ul>
+									</li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/comments">Comments and Replies</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotation-event">Annotation Events</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/custom-tools">Custom tools</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotations-in-mobile-view">Annotation in Mobile View</a></li>
+									<li><a href="/document-processing/pdf/pdf-viewer/vue/annotation/annotations-api">APIs</a></li>
 								</ul>
 							</li>
 							<li>Redaction

Document-Processing/PDF/PDF-Viewer/vue/annotation/annotation-permission.md

@@ -0,0 +1,153 @@
+---
+layout: post
+title: Annotations Permission in Vue PDF Viewer | Syncfusion
+description: Learn here all about how to use annotation permissions in Syncfusion Vue PDF Viewer using programmatic APIs.
+platform: document-processing
+control: PDF Viewer
+documentation: ug
+domainurl: ##DomainURL##
+---
+
+# Annotation permissions in Vue
+
+Use [annotationSettings](https://ej2.syncfusion.com/vue/documentation/api/pdfviewer/index-default#annotationsettings) to control creation-time permissions and default behavior for annotations in the PDF Viewer. These settings establish defaults for annotations created through the UI and programmatic flows.
+
+## Common permissions
+
+- `isLock`: Lock an annotation so it cannot be moved, resized, edited, or deleted.
+- `skipPrint`: Exclude annotations from the print output when printing from the viewer.
+- `skipDownload`: Exclude annotations from the exported/downloaded PDF.
+
+Example: set default `annotationSettings` as a component property on `PdfViewerComponent`.
+
+{% tabs %}
+{% highlight html tabtitle="Options API (~/src/App.vue)" %}
+
+<template>
+  <div id="app">
+    <ejs-pdfviewer 
+      id="pdfViewer" 
+      :documentPath="documentPath" 
+      :resourceUrl="resourceUrl"
+      :annotationSettings="annotationSettings"
+      style="height: 650px;">
+    </ejs-pdfviewer>
+  </div>
+</template>
+
+<script>
+import {
+  PdfViewerComponent, Toolbar, Magnification, Navigation, LinkAnnotation,
+  BookmarkView, ThumbnailView, Print, TextSelection, TextSearch,
+  Annotation, FormDesigner, FormFields, PageOrganizer
+} from '@syncfusion/ej2-vue-pdfviewer';
+
+export default {
+  name: "App",
+  components: {
+    "ejs-pdfviewer": PdfViewerComponent
+  },
+  data() {
+    return {
+      documentPath: "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf",
+      resourceUrl: "https://cdn.syncfusion.com/ej2/31.2.2/dist/ej2-pdfviewer-lib",
+      annotationSettings: {
+        isLock: true,
+        skipPrint: true,
+        skipDownload: true
+      }
+    };
+  },
+  provide: {
+    PdfViewer: [Toolbar, Magnification, Navigation, LinkAnnotation, BookmarkView, 
+      ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, 
+      FormDesigner, PageOrganizer]
+  }
+}
+</script>
+
+{% endhighlight %}
+{% endtabs %}
+
+## Individual permissions
+
+- `isPrint`: Controls whether a specific annotation participates in printing. Set to `false` to exclude only that annotation from print output.
+- `isLock`: Lock or unlock a specific annotation instance programmatically.
+
+Example: set per-annotation defaults for text markup, shapes, and measurements as component properties.
+
+{% tabs %}
+{% highlight html tabtitle="Options API (~/src/App.vue)" %}
+
+<template>
+  <div id="app">
+    <ejs-pdfviewer 
+      id="pdfViewer" 
+      :documentPath="documentPath" 
+      :resourceUrl="resourceUrl"
+      :highlightSettings="highlightSettings"
+      :rectangleSettings="rectangleSettings"
+      :distanceSettings="distanceSettings"
+      style="height: 650px;">
+    </ejs-pdfviewer>
+  </div>
+</template>
+
+<script>
+import {
+  PdfViewerComponent, Toolbar, Magnification, Navigation, LinkAnnotation,
+  BookmarkView, ThumbnailView, Print, TextSelection, TextSearch,
+  Annotation, FormDesigner, FormFields, PageOrganizer
+} from '@syncfusion/ej2-vue-pdfviewer';
+
+export default {
+  name: "App",
+  components: {
+    "ejs-pdfviewer": PdfViewerComponent
+  },
+  data() {
+    return {
+      documentPath: "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf",
+      resourceUrl: "https://cdn.syncfusion.com/ej2/31.2.2/dist/ej2-pdfviewer-lib",
+      highlightSettings: {
+        isPrint: true,
+        isLock: false
+      },
+      rectangleSettings: {
+        isPrint: false,
+        isLock: true
+      },
+      distanceSettings: {
+        isPrint: true,
+        isLock: false
+      }
+    };
+  },
+  provide: {
+    PdfViewer: [Toolbar, Magnification, Navigation, LinkAnnotation, BookmarkView, 
+      ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, 
+      FormDesigner, PageOrganizer]
+  }
+}
+</script>
+
+{% endhighlight %}
+{% endtabs %}
+
+## Behavior notes
+
+- `isLock true`: The annotation is locked; users cannot move, resize, or edit it through the UI until it is unlocked.
+- `skipPrint true`: All annotations are omitted from the print output initiated from the viewer.
+- `skipDownload true`: All annotations are omitted from the exported/downloaded PDF from the viewer.
+- `isPrint` on an individual annotation: Use this when you only want to exclude a particular annotation from printing while leaving others printable.
+
+[View Sample on GitHub](https://github.com/SyncfusionExamples/vue-pdf-viewer-examples)
+
+## See also
+
+- [Annotation Overview](../overview)
+- [Annotation Types](../annotation-types)
+- [Create and Modify Annotation](./create-modify-annotation)
+- [Customize Annotation](./customize-annotation)
+- [Annotation Events](./annotation-event)
+- [Annotations API](./annotations-api)