Замечания (аннотации)
AnnotateText
Запись. Блокируется режимом PILOT_READONLY.
Создать замечание к тексту на документе. Работает с любыми документами (PDF, XPS). Автоматически находит слово/фразу и выделяет её. Используйте для рецензирования и пометки ошибок. По умолчанию создаёт замечание в формате Markup (клиент Pilot 26.20+): выделение, подчёркивание или зачёркивание. format=legacy — старый формат (текстовая заметка) для серверов и клиентов старше 26.20. Пример: searchText='квартыры', comment='Опечатка: должно быть квартиры'
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
documentId |
string |
да | GUID документа | |
searchText |
string |
да | Слово или фраза из документа для выделения (копируйте из текста документа, включая опечатки) | |
comment |
string |
да | Пояснение к замечанию (что не так, как исправить) | |
page |
int |
нет | -1 |
Номер страницы (с 0). Если -1, ищет на всех страницах. |
color |
string |
нет | "red" |
Цвет выделения |
occurrenceIndex |
int |
нет | 0 |
Какое вхождение использовать, если найдено несколько (с 0) |
style |
string |
нет | "highlight" |
Вид выделения (только format=markup): highlight, underline, strikeout |
format |
string |
нет | "markup" |
Формат замечания: markup (клиент Pilot 26.20+) или legacy (старый, до 26.20) |
BuildAnnotationXml
Чтение.
Получить XML-разметку аннотации в старом (legacy) формате без создания объекта. Для замечаний в формате Markup (клиент Pilot 26.20+) не подходит. Полезно для проверки или ручной вставки в атрибут.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
shape |
string |
да | Тип фигуры: rectangle, ellipse, triangle, arrow, point | |
color |
string |
да | Цвет: red, green, blue, yellow, pink, black или hex #RRGGBB | |
x |
double |
да | Координата X | |
y |
double |
да | Координата Y | |
width |
double |
нет | 100 |
Ширина (для arrow: смещение по X) |
height |
double |
нет | 60 |
Высота (для arrow: смещение по Y) |
page |
int |
нет | 0 |
Номер страницы |
CreateAnnotation
Запись. Блокируется режимом PILOT_READONLY.
Нарисовать графическую фигуру на документе (прямоугольник, эллипс, треугольник, стрелку, линию, ломаную, многоугольник, рисунок от руки, точку). По умолчанию создаёт замечание в формате Markup (клиент Pilot 26.20+); format=legacy — старый формат для серверов и клиентов старше 26.20 (только rectangle, ellipse, triangle, arrow, point, без strokeWidth/points/cloud/startEnding/endEnding). Несколько фигур в одном замечании — CreateMarkupAnnotation. Для замечаний к тексту с выделением слова лучше подходит AnnotateText. КООРДИНАТЫ: передавайте ПИКСЕЛЬНЫЕ координаты прямо с изображения от GetDocumentPageImage. Инструмент сам пересчитает их в единицы документа по DPI. Rectangle: x,y = левый верхний угол, width/height = размеры. Ellipse: x,y = центр объекта, width/height = диаметры. Arrow/line: x,y = куда указывает остриё, width/height = смещение хвоста от цели. Polyline/polygon/ink: вершины в points. Point: x,y = положение стикера.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
documentId |
string |
да | GUID документа, на котором создаётся замечание | |
shape |
string |
да | Тип: rectangle, ellipse, triangle, arrow, line, polyline, polygon, ink, point. Для текстовых замечаний используйте AnnotateText! | |
color |
string |
да | Цвет: red, green, blue, yellow, pink, black или hex #RRGGBB | |
x |
double |
да | Координата X в пикселях изображения. Rectangle/triangle: левый верхний угол. Ellipse: центр. Arrow: цель остриём. | |
y |
double |
да | Координата Y в пикселях изображения. | |
width |
double |
нет | 100 |
Ширина в пикселях. Arrow: смещение хвоста по X. Ellipse: полный диаметр. |
height |
double |
нет | 60 |
Высота в пикселях. Arrow: смещение хвоста по Y. Ellipse: полный диаметр. |
page |
int |
нет | 0 |
Номер страницы (начинается с 0) |
content |
string |
нет | "" |
Текст пояснения к замечанию. Заполняйте для рецензий и комментариев. |
dpi |
int |
нет | 150 |
DPI изображения от GetDocumentPageImage (по умолчанию 150) |
remarkTypeName |
string |
нет | "doc_issue" |
Системное имя типа замечания в базе |
attributeName |
string |
нет | "annotation" |
Системное имя атрибута для XML-разметки |
strokeWidth |
double |
нет | 2 |
Толщина линии в DIP (только markup) |
points |
string |
нет | "" |
Вершины для polyline/polygon/ink в пикселях изображения: 'x1,y1;x2,y2;...' |
cloud |
bool |
нет | false |
Облачная граница для polyline/polygon (только markup) |
startEnding |
string |
нет | "" |
Окончание в начале линии для arrow/line: none, openarrow |
endEnding |
string |
нет | "" |
Окончание в конце линии (у острия) для arrow/line. У arrow по умолчанию openarrow |
format |
string |
нет | "markup" |
Формат замечания: markup (клиент Pilot 26.20+) или legacy (старый, до 26.20) |
CreateMarkupAnnotation
Запись. Блокируется режимом PILOT_READONLY.
Создать ОДНО замечание из нескольких фигур в формате Markup (клиент Pilot 26.20+). shapesJson — JSON-массив фигур с полями как у CreateAnnotation: shape (rectangle, ellipse, triangle, arrow, line, polyline, polygon, ink, point), x, y, width, height, page, color, strokeWidth, points, cloud, startEnding, endEnding. Координаты — в ПИКСЕЛЯХ изображения от GetDocumentPageImage (dpi должен совпадать). Пример: [{"shape":"rectangle","x":150,"y":150,"width":200,"height":100,"color":"blue"},{"shape":"arrow","x":150,"y":150,"width":80,"height":60}]
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
documentId |
string |
да | GUID документа | |
shapesJson |
string |
да | JSON-массив фигур | |
content |
string |
нет | "" |
Текст замечания |
dpi |
int |
нет | 150 |
DPI изображения от GetDocumentPageImage (по умолчанию 150) |
remarkTypeName |
string |
нет | "doc_issue" |
Системное имя типа замечания в базе |
GetAnnotations
Чтение.
Прочитать замечания документа (любого типа замечаний, без удалённых в корзину). Для каждого: ID, тип, текст, автор, дата создания, версия файла (папка замечаний), формат (markup/legacy) и фигуры: вид, страница (с 0), ограничивающий прямоугольник x, y, width, height в ПИКСЕЛЯХ изображения (начало — левый верхний угол) и стиль. Для markup читается версия, совпадающая с текущей версией файла, иначе последняя. Результат — JSON-массив.
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
documentId |
string |
да | GUID документа | |
dpi |
int |
нет | 150 |
DPI изображения от GetDocumentPageImage, в пикселях которого возвращаются координаты (по умолчанию 150) |