Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions README.md

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions docs/Annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ Provides annotation.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**contents** | **string** | Get the annotation content. | [optional]
**creationDate** | **string** | The date and time when the annotation was created. | [optional]
**subject** | **string** | Get the annotation subject. | [optional]
**title** | **string** | Get the annotation title. | [optional]
**modified** | **string** | The date and time when the annotation was last modified. | [optional]
**id** | **string** | Gets ID of the annotation. | [optional]
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
Expand Down
3 changes: 0 additions & 3 deletions docs/AnnotationInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**annotationType** | [**AnnotationType**](AnnotationType.md) | Gets annotation type. |
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
Expand Down
11 changes: 11 additions & 0 deletions docs/CapStyle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CapStyle
Style of line ending of Ink annotation line.

## Enum
Name | Type | Value
------------ | ------------- | -------------
**Rectangular** | **string** | 'Rectangular'
**Rounded** | **string** | 'Rounded'

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/capStyle.ts)

28 changes: 28 additions & 0 deletions docs/CaretAnnotation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CaretAnnotation
Provides CaretAnnotation.

*Inherited from [MarkupAnnotation](MarkupAnnotation.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
**frame** | [**RectanglePdf**](RectanglePdf.md) | Gets or sets caret rectangle. | [optional]
**symbol** | [**CaretSymbol**](CaretSymbol.md) | Gets or sets symbol associated with caret. | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**richText** | **string** | Get the annotation RichText.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**name** | **string** | Gets Name of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation.<br />*Inherited from [Annotation](Annotation.md)* |
**pageIndex** | **number** | Gets PageIndex of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**zIndex** | **number** | Gets ZIndex of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/caretAnnotation.ts)

13 changes: 13 additions & 0 deletions docs/CaretAnnotationResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CaretAnnotationResponse


*Inherited from [AsposeResponse](AsposeResponse.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**annotation** | [**CaretAnnotation**](CaretAnnotation.md) | | [optional]
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/caretAnnotationResponse.ts)

12 changes: 12 additions & 0 deletions docs/CaretAnnotations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CaretAnnotations
List of annotations.

*Inherited from [LinkElement](LinkElement.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**Array&lt;CaretAnnotation&gt;**](CaretAnnotation.md) | | [optional]
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/caretAnnotations.ts)

13 changes: 13 additions & 0 deletions docs/CaretAnnotationsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CaretAnnotationsResponse


*Inherited from [AsposeResponse](AsposeResponse.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**annotations** | [**CaretAnnotations**](CaretAnnotations.md) | | [optional]
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/caretAnnotationsResponse.ts)

11 changes: 11 additions & 0 deletions docs/CaretSymbol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CaretSymbol
A symbol to be associated with the caret.

## Enum
Name | Type | Value
------------ | ------------- | -------------
**None** | **string** | 'None'
**Paragraph** | **string** | 'Paragraph'

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/caretSymbol.ts)

6 changes: 3 additions & 3 deletions docs/CircleAnnotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Name | Type | Description | Notes
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
**interiorColor** | [**Color**](Color.md) | Get the annotation InteriorColor.<br />*Inherited from [CommonFigureAnnotation](CommonFigureAnnotation.md)* | [optional]
**frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame.<br />*Inherited from [CommonFigureAnnotation](CommonFigureAnnotation.md)* | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**richText** | **string** | Get the annotation RichText.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/CommonFigureAnnotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interiorColor** | [**Color**](Color.md) | Get the annotation InteriorColor. | [optional]
**frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame. | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**richText** | **string** | Get the annotation RichText.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/FreeTextAnnotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Name | Type | Description | Notes
**intent** | [**FreeTextIntent**](FreeTextIntent.md) | Gets or sets the intent of the free text annotation. | [optional]
**rotate** | [**Rotation**](Rotation.md) | Angle of annotation rotation. | [optional]
**textStyle** | [**TextStyle**](TextStyle.md) | Text style of the annotation. |
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**richText** | **string** | Get the annotation RichText.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
Expand Down
27 changes: 27 additions & 0 deletions docs/HighlightAnnotation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# HighlightAnnotation
Provides HighlightAnnotation.

*Inherited from [MarkupAnnotation](MarkupAnnotation.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
**quadPoints** | [**Array&lt;Point&gt;**](Point.md) | Gets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation. | [optional]
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**subject** | **string** | Get the annotation subject.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**title** | **string** | Get the annotation title.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**richText** | **string** | Get the annotation RichText.<br />*Inherited from [MarkupAnnotation](MarkupAnnotation.md)* | [optional]
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**name** | **string** | Gets Name of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation.<br />*Inherited from [Annotation](Annotation.md)* |
**pageIndex** | **number** | Gets PageIndex of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**zIndex** | **number** | Gets ZIndex of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/highlightAnnotation.ts)

13 changes: 13 additions & 0 deletions docs/HighlightAnnotationResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# HighlightAnnotationResponse


*Inherited from [AsposeResponse](AsposeResponse.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**annotation** | [**HighlightAnnotation**](HighlightAnnotation.md) | | [optional]
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/highlightAnnotationResponse.ts)

12 changes: 12 additions & 0 deletions docs/HighlightAnnotations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# HighlightAnnotations
List of annotations.

*Inherited from [LinkElement](LinkElement.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**Array&lt;HighlightAnnotation&gt;**](HighlightAnnotation.md) | | [optional]
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/highlightAnnotations.ts)

13 changes: 13 additions & 0 deletions docs/HighlightAnnotationsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# HighlightAnnotationsResponse


*Inherited from [AsposeResponse](AsposeResponse.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**annotations** | [**HighlightAnnotations**](HighlightAnnotations.md) | | [optional]
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/highlightAnnotationsResponse.ts)

Loading