Skip to content

Commit 79c011f

Browse files
committed
Add Enum's docs
1 parent 6214854 commit 79c011f

File tree

134 files changed

+592
-96
lines changed

Some content is hidden

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

134 files changed

+592
-96
lines changed

docs/Annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ Name | Type | Description | Notes
2020
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
2121
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
2222

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)
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)
2424

docs/AnnotationFlags.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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+
[[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)
19+

docs/AnnotationInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ Name | Type | Description | Notes
2121
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation.<br />*Inherited from [Annotation](Annotation.md)* | [optional]
2222
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
2323

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)
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)
2525

docs/AnnotationState.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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+
[[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)
16+

docs/AnnotationType.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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+
[[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)
36+

docs/AnnotationsInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ Name | Type | Description | Notes
88
**list** | [**Array&lt;AnnotationInfo&gt;**](AnnotationInfo.md) | | [optional]
99
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
1010

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)
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)
1212

docs/AnnotationsInfoResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Name | Type | Description | Notes
99
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
1010
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]
1111

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)
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)
1313

docs/AntialiasingProcessingType.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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+
[[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)
10+

docs/AppendDocument.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ Name | Type | Description | Notes
88
**startPage** | **number** | Appending start page. |
99
**endPage** | **number** | Appending end page. |
1010

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)
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)
1212

docs/AsposeResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ Name | Type | Description | Notes
77
**code** | **number** | Response status code. |
88
**status** | **string** | Response status. | [optional]
99

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)
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/asposeResponse.ts)
1111

0 commit comments

Comments
 (0)