Skip to content

Commit 965fe15

Browse files
evgeny-porodnovevgeny-porodnov
authored
Merge pull request #8 from kaferi/master
Create Documentation
2 parents de391d3 + cdf425a commit 965fe15

File tree

136 files changed

+6957
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+6957
-5
lines changed

‎README.md

Lines changed: 332 additions & 5 deletions
Large diffs are not rendered by default.

‎docs/Annotation.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Annotation
2+
Provides annotation.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**contents** | **string** | Get the annotation content. | [optional]
9+
**creationDate** | **string** | The date and time when the annotation was created. | [optional]
10+
**subject** | **string** | Get the annotation subject. | [optional]
11+
**title** | **string** | Get the annotation title. | [optional]
12+
**modified** | **string** | The date and time when the annotation was last modified. | [optional]
13+
**id** | **string** | Gets ID of the annotation. | [optional]
14+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
15+
**name** | **string** | Gets Name of the annotation. | [optional]
16+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. |
17+
**pageIndex** | **number** | Gets PageIndex of the annotation. | [optional]
18+
**zIndex** | **number** | Gets ZIndex of the annotation. | [optional]
19+
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
20+
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
21+
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
22+
23+
[[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/annotation.ts)
24+

‎docs/AnnotationFlags.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AnnotationFlags
2+
A set of flags specifying various characteristics of the annotation.
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**Default** | **string** | 'Default'
8+
**Hidden** | **string** | 'Hidden'
9+
**Invisible** | **string** | 'Invisible'
10+
**Locked** | **string** | 'Locked'
11+
**LockedContents** | **string** | 'LockedContents'
12+
**NoRotate** | **string** | 'NoRotate'
13+
**NoView** | **string** | 'NoView'
14+
**NoZoom** | **string** | 'NoZoom'
15+
**Print** | **string** | 'Print'
16+
**ReadOnly** | **string** | 'ReadOnly'
17+
**ToggleNoView** | **string** | 'ToggleNoView'
18+
19+
[[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/annotationFlags.ts)
20+

‎docs/AnnotationInfo.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AnnotationInfo
2+
Provides annotation.
3+
4+
*Inherited from [Annotation](Annotation.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**annotationType** | [**AnnotationType**](AnnotationType.md) | Gets annotation type. |
9+
**contents** | **string** | Get the annotation content.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
10+
**creationDate** | **string** | The date and time when the annotation was created.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
11+
**subject** | **string** | Get the annotation subject.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
12+
**title** | **string** | Get the annotation title.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
13+
**modified** | **string** | The date and time when the annotation was last modified.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
14+
**id** | **string** | Gets ID of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
15+
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
16+
**name** | **string** | Gets Name of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
17+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation.<br />*Inherited from [Annotation](Annotation.md)* |
18+
**pageIndex** | **number** | Gets PageIndex of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
19+
**zIndex** | **number** | Gets ZIndex of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
20+
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
21+
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
22+
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
23+
24+
[[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/annotationInfo.ts)
25+

‎docs/AnnotationState.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# AnnotationState
2+
The enumeration of states to which the original annotation can be set.
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**Accepted** | **string** | 'Accepted'
8+
**Cancelled** | **string** | 'Cancelled'
9+
**Completed** | **string** | 'Completed'
10+
**Marked** | **string** | 'Marked'
11+
**None** | **string** | 'None'
12+
**Rejected** | **string** | 'Rejected'
13+
**Undefined** | **string** | 'Undefined'
14+
**Unmarked** | **string** | 'Unmarked'
15+
16+
[[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/annotationState.ts)
17+

‎docs/AnnotationType.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AnnotationType
2+
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**Caret** | **string** | 'Caret'
8+
**Circle** | **string** | 'Circle'
9+
**FileAttachment** | **string** | 'FileAttachment'
10+
**FreeText** | **string** | 'FreeText'
11+
**Highlight** | **string** | 'Highlight'
12+
**Ink** | **string** | 'Ink'
13+
**Line** | **string** | 'Line'
14+
**Link** | **string** | 'Link'
15+
**Movie** | **string** | 'Movie'
16+
**PDF3D** | **string** | 'PDF3D'
17+
**Polygon** | **string** | 'Polygon'
18+
**PolyLine** | **string** | 'PolyLine'
19+
**Popup** | **string** | 'Popup'
20+
**PrinterMark** | **string** | 'PrinterMark'
21+
**Redaction** | **string** | 'Redaction'
22+
**RichMedia** | **string** | 'RichMedia'
23+
**Screen** | **string** | 'Screen'
24+
**Sound** | **string** | 'Sound'
25+
**Square** | **string** | 'Square'
26+
**Squiggly** | **string** | 'Squiggly'
27+
**Stamp** | **string** | 'Stamp'
28+
**StrikeOut** | **string** | 'StrikeOut'
29+
**Text** | **string** | 'Text'
30+
**TrapNet** | **string** | 'TrapNet'
31+
**Underline** | **string** | 'Underline'
32+
**Unknown** | **string** | 'Unknown'
33+
**Watermark** | **string** | 'Watermark'
34+
**Widget** | **string** | 'Widget'
35+
36+
[[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/annotationType.ts)
37+

‎docs/AnnotationsInfo.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AnnotationsInfo
2+
List of annotations.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**list** | [**Array&lt;AnnotationInfo&gt;**](AnnotationInfo.md) | | [optional]
9+
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
10+
11+
[[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/annotationsInfo.ts)
12+

‎docs/AnnotationsInfoResponse.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AnnotationsInfoResponse
2+
3+
4+
*Inherited from [AsposeResponse](AsposeResponse.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**annotations** | [**AnnotationsInfo**](AnnotationsInfo.md) | | [optional]
9+
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
10+
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]
11+
12+
[[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/annotationsInfoResponse.ts)
13+

‎docs/AntialiasingProcessingType.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AntialiasingProcessingType
2+
This enum describes possible antialiasing measures during conversion
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**NoAdditionalProcessing** | **string** | 'NoAdditionalProcessing'
8+
**TryCorrectResultHtml** | **string** | 'TryCorrectResultHtml'
9+
10+
[[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/antialiasingProcessingType.ts)
11+

‎docs/AppendDocument.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AppendDocument
2+
Class for appendDocument service request building.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**document** | **string** | Document to append (server path). |
8+
**startPage** | **number** | Appending start page. |
9+
**endPage** | **number** | Appending end page. |
10+
11+
[[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/appendDocument.ts)
12+

0 commit comments

Comments
 (0)