@@ -15,14 +15,15 @@ permalink: /api/class/annotation/ellipse.html
1515
1616## API Index
1717
18- | API Name | Description |
19- | ---------------------- | ----------------------------------------------------------- |
20- | [ ` uid ` ] ( #uid ) | Return the uid of the annotation. |
21- | [ ` pageUid ` ] ( #pageuid ) | Return the uid of the page where the annotation is located. |
22- | [ ` creationDate ` ] ( #creationdate ) | Return the creation date of the annotation. |
23- | [ ` modificationDate ` ] ( #modificationdate ) | Return the modification date of the annotation. |
24- | [ ` getOptions() ` ] ( #getoptions ) | Get the annotation options. |
25- | [ ` updateOptions() ` ] ( #updateoptions ) | Update the annotation options. |
18+ | API Name | Description |
19+ | --------------------------------------- | ------------------------------------------------------------------------------------------- |
20+ | [ ` uid ` ] ( #uid ) | Return the uid of the annotation. |
21+ | [ ` pageUid ` ] ( #pageuid ) | Return the uid of the page where the annotation is located. |
22+ | [ ` creationDate ` ] ( #creationdate ) | Return the creation date of the annotation. |
23+ | [ ` flattened ` ] ( #flattened ) | Flattens the annotation onto the image layer, or inspect if the annotation is flattened. |
24+ | [ ` modificationDate ` ] ( #modificationdate ) | Return the modification date of the annotation. |
25+ | [ ` getOptions() ` ] ( #getoptions ) | Get the annotation options. |
26+ | [ ` updateOptions() ` ] ( #updateoptions ) | Update the annotation options. |
2627
2728## uid
2829
@@ -89,6 +90,22 @@ readonly creationDate: string;
8990- It will return ` '' ` , if the annotation is be deleted.
9091{% endcomment %}
9192
93+ ## flattened
94+
95+ Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
96+
97+ ** Syntax**
98+
99+ ``` typescript
100+ flattened : boolean ;
101+ ```
102+
103+ ** Remark**
104+
105+ Flattened annotations move below all unflattened annotations on the page, and are stacked amongst themselves accordingly.
106+
107+ Flattened annotations become part of the page layer upon file export and cease to be annotations.
108+
92109## modificationDate
93110
94111Return the modification date of the annotation.
0 commit comments