Changes for page Интерфейс file

Last modified by Bimit Administrator on 02.10.2024, 11:55
From version 8.1
edited by Bimit Administrator
on 18.02.2022, 13:19
Change comment: There is no comment for this version
To version 16.3
edited by Bimit Administrator
on 27.08.2024, 09:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -11,24 +11,45 @@
11 11  * [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
12 12  * [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
13 13  * [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
14 -* insertRow - функция которая вставляет строку на указанную позицию на странице эксель файла
15 -* replaceRow - функция которая замещает строку на указанной позицию на странице эксель файла
16 -* deleteRow - функция которая удаляет строку с указанной позиции на странице эксель файла
17 -* autoSizeColumns - функция установки автоматической ширины колонок страницы эксель файла
14 +* [[insertRow>>path:#_Toc15]] - функция которая вставляет строку на указанную позицию на странице эксель файла
15 +* [[replaceRow>>path:#_Toc16]] - функция которая замещает строку на указанной позицию на странице эксель файла
16 +* [[deleteRow>>path:#_Toc17]] - функция которая удаляет строку с указанной позиции на странице эксель файла
17 +* [[autoSizeColumns>>path:#_Toc18]] - функция установки автоматической ширины колонок страницы эксель файла
18 18  * [[getDocument>>path:#_Toc11]] - получение интерфейса текущего документа XWPFDocument (docx) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFDocument.html), предоставляет полный доступ к инструментарию формирования документа MSWord
19 19  * [[getParagraph>>path:#_Toc12]] - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord
20 20  * [[getWorkbook>>path:#_Toc13]] - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель
21 21  * [[getSheet>>path:#_Toc14]] - получение интерфейса текущей страницы с таблицей (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Sheet.html) документа таблицы эксель
22 +* [[addAreaBreak>>path:#_Toc30]] - добавление разрыва области PDF документа
23 +* [[addImage>>path:#_Toc31]] - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
24 +* [[addDrawing>>path:#_Toc32]] - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
25 +* [[addCell>>path:#_Toc22]] - создание ячейки в указанный столбец
26 +* [[replaceRow>>path:#_Toc23]] - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
27 +* [[sortASC>>path:#_Toc24]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
28 +* [[sortDESC>>path:#_Toc25]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
29 +* [[saveTempTable>>path:#_Toc26]] - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
30 +* [[xlsxToJSON>>path:#_Toc27]] - преобразование содержимого документа Excel (XLSX, XLS)
31 +* [[getResource>>path:#_Toc28]] - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
32 +* [[makeGrandSmetaExelTable>>path:#_Toc29]] - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
22 22  
34 +**Генерация документа с использованием шаблона**
23 23  
36 +* [[templateToPdf>>path:#_Toc19]] - генерация pdf документа из шаблона
37 +
38 +**Генерация отчета по коллизиям и атрибутам**
39 +
40 +* [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
41 +* [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
42 +
24 24  [[Примеры использования в плагинах>>Примеры использования в плагинах]]
25 25  
26 26  
27 27  (% class="box infomessage" %)
28 28  (((
29 -**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
48 +**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
30 30  )))
31 31  
51 +* **file.create(формат создаваемого файла)**
52 +
32 32  **Пример использования:**
33 33  
34 34  
... ... @@ -42,8 +42,8 @@
42 42  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
43 43  )))
44 44  
45 -* с базовыми настройками
46 -* с указанием размера шрифта, и указанием жирный/простой
66 +* **file.addTitle(Текст)** - с базовыми настройками
67 +* **file.addTitle(Текст, Размер шрифта, жирный/не жирный)** - с указанием размера шрифта, и указанием жирный/простой
47 47  
48 48  **Примеры использования:**
49 49  
... ... @@ -61,8 +61,8 @@
61 61  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
62 62  )))
63 63  
64 -* с базовыми настройками
65 -* с указанием отступа, размера шрифта, и указанием жирный/простой
85 +* **file.addParagraph("Текст")** - с базовыми настройками
86 +* **file.addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный)** - с указанием отступа, размера шрифта, и указанием жирный/простой
66 66  
67 67  **Примеры использования:**
68 68  
... ... @@ -82,10 +82,11 @@
82 82  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
83 83  )))
84 84  
106 +* **file.addCenterParagraph("текст", размер шрифта, жирный/не жирный)**
107 +
85 85  **Пример использования:**
86 86  
87 87  
88 -
89 89  {{code language="java"}}
90 90  addCenterParagraph("Текст", 10, true)
91 91  {{/code}}
... ... @@ -96,6 +96,8 @@
96 96  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
97 97  )))
98 98  
121 +* **file.addRightParagraph("текст", размер шрифта, жирный/не жирный)**
122 +
99 99  **Пример использования:**
100 100  
101 101  
... ... @@ -109,6 +109,8 @@
109 109  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
110 110  )))
111 111  
136 +* **file.addLeftParagraph("текст", размер шрифта, жирный/не жирный)**
137 +
112 112  **Пример использования:**
113 113  
114 114  
... ... @@ -122,6 +122,8 @@
122 122  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
123 123  )))
124 124  
151 +* **file.addTextBreak()**
152 +
125 125  **Пример использования:**
126 126  
127 127  
... ... @@ -135,12 +135,17 @@
135 135  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
136 136  )))
137 137  
138 -* с указанием размера текста и указанием жирный/простой
139 -* с опциями (file.addText(“Строка, которая появится в файле”))
166 +* **file.addText(Object objectValue)** - добавление объекта в строковом представлении
167 +* **file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)**
168 +* **file.addText(“Строка, которая появится в файле”)**
169 +* **file.addText(long longValue)** - добавление числа типа long в строковом представлении
170 +* **file.addText(double doubleValue)** - добавление числа типа double в строковом представлении
140 140  
141 141  **Примеры использования:**
142 142  
143 143  {{code language="java"}}
175 +{{/code}}
176 +{{code language="java"}}
144 144  file.addText("Строка, которая появится в файле"), 10, false)
145 145  {{/code}}
146 146  
... ... @@ -148,12 +148,20 @@
148 148  file.addText("Строка, которая появится в файле")
149 149  {{/code}}
150 150  
184 +{{code language="java"}}
185 +{{/code}}
151 151  
187 +{{code language="java"}}
188 +{{/code}}
189 +
190 +
152 152  (% class="box infomessage" %)
153 153  (((
154 -**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
193 +**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
155 155  )))
156 156  
196 +* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
197 +
157 157  **Пример использования:**
158 158  
159 159  
... ... @@ -164,9 +164,11 @@
164 164  
165 165  (% class="box infomessage" %)
166 166  (((
167 -**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
208 +**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
168 168  )))
169 169  
211 +* **file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)**
212 +
170 170  **Пример использования:**
171 171  
172 172  
... ... @@ -177,6 +177,63 @@
177 177  
178 178  (% class="box infomessage" %)
179 179  (((
223 +**{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
224 +)))
225 +
226 +* **file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
227 +
228 +**Пример использования:**
229 +
230 +{{code language="java"}}
231 +file.insertRow(6, "Вставленная строка", 1 , 2.453, new Date(), Calendar.getInstance());
232 +{{/code}}
233 +
234 +
235 +(% class="box infomessage" %)
236 +(((
237 +**{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
238 +)))
239 +
240 +* **file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
241 +
242 +**Пример использования:**
243 +
244 +{{code language="java"}}
245 +file.replaceRow(7, "Замещенная строка", 4 , 5.678, new Date(), Calendar.getInstance());
246 +{{/code}}
247 +
248 +
249 +(% class="box infomessage" %)
250 +(((
251 +**{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
252 +)))
253 +
254 +* **file.deleteRow(индекс)**
255 +
256 +**Пример использования:**
257 +
258 +{{code language="java"}}
259 +file.deleteRow(3);
260 +{{/code}}
261 +
262 +
263 +(% class="box infomessage" %)
264 +(((
265 +**{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
266 +)))
267 +
268 +* **file.autoSizeColumns()** - для всех колонок на странице
269 +* **file.autoSizeColumns(индекс колонки)** - для конкретной колонки на странице
270 +
271 +**Пример использования:**
272 +
273 +{{code language="java"}}
274 +file.autoSizeColumns()
275 +{{/code}}
276 +
277 +
278 +(% class="box infomessage" %)
279 +(((
180 180  **{{id name="_Toc11"/}}getDocument** - получение интерфейса текущего документа XWPFDocument (docx) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFDocument.html), предоставляет полный доступ к инструментарию формирования документа MSWord (полную документацию см. [[https:~~/~~/poi.apache.org/apidocs/4.1/)>>https://poi.apache.org/apidocs/4.1/)]]
181 181  )))
182 182  
... ... @@ -214,6 +214,196 @@
214 214  {{/code}}
215 215  
216 216  
317 +(% class="box infomessage" %)
318 +(((
319 +**{{id name="_Toc19"/}}templateToPdf** - генерация pdf документа из шаблона
320 +)))
321 +
322 +* **[[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)**
323 +* **file.templateToPdf(template)**
324 +
325 +**Пример использования:**
326 +
327 +{{code language="java"}}
328 +def project = bim.getProject()
329 +template.add("project", project)
330 +file.templateToPdf(template)
331 +{{/code}}
332 +
333 +
334 +(% class="box infomessage" %)
335 +(((
336 +**{{id name="_Toc20"/}}collisionsToPdf** - генерация pdf по списку коллизий
337 +)))
338 +
339 +* **file.collisionsToPdf(template, list, params):**
340 +* **template** - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
341 +* **list** - список коллизий. Обязательное поле. Получить данный лист необходимо командой [[bim.getCollisionsForReport()>>https://wiki.bimit.ru/bin/view/API/%D0%9F%D0%BB%D0%B0%D0%B3%D0%B8%D0%BD%20API/%D0%98%D0%BD%D1%82%D0%B5%D1%80%D1%84%D0%B5%D0%B9%D1%81%20bim/#_Toc26]]
342 +* **params** - необязательный параметр (описание ниже)
343 +
344 + Параметры при генерации отчета по коллизиям:
345 + pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
346 + fontSize - int значение размера шрифта (в pt)
347 +
348 + **Пример использования:**
349 +
350 +{{code language="java"}}
351 + def param = [:]
352 + param.add("pageSize", 3)
353 + param.add("fontSize", 12)
354 +{{/code}}
355 +
356 + По умолчанию параметры принимают следующие значения:
357 + pageSize - 4
358 + fontSize - 8
359 +
360 +
361 +**Пример использования:**
362 +
363 +{{code language="java"}}
364 +def collisionList = bim.getCollisionsForReport()
365 + def param = [:]
366 + param.add("pageSize", 3)
367 + param.add("fontSize", 12)
368 + file.collisionsToPdf(template, collisionList, param)
369 +{{/code}}
370 +
371 +{{code language="java"}}
372 + def collisionList = bim.getCollisionsForReport()
373 + file.collisionsToPdf(collisionList)
374 +{{/code}}
375 +
376 +
377 +(% class="box infomessage" %)
378 +(((
379 +**{{id name="_Toc21"/}}attributesToPdf** - генерация pdf по списку атрибутов
380 +)))
381 +
382 +* **file.attributesToPdf(template, list, params)**
383 +
384 +(% class="box infomessage" %)
385 +(((
386 +**{{id name="_Toc30"/}}addAreaBreak** - добавление разрыва области PDF документа
387 +)))
388 +
389 +* **file.addAreaBreak() **
390 +
391 +**Пример использования:**
392 +
393 +{{code language="java"}}{{/code}}
394 +
395 +(% class="box infomessage" %)
396 +(((
397 +**{{id name="_Toc31"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
398 +)))
399 +
400 +* **file.addImage(byte[] imageFile) **
401 +
402 +**Пример использования:**
403 +
404 +{{code language="java"}}{{/code}}
405 +
406 +(% class="box infomessage" %)
407 +(((
408 +**{{id name="_Toc32"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
409 +)))
410 +
411 +* **file.addDrawing(byte[] drawingPage, double[][] arr) **
412 +
413 +**Пример использования:**
414 +
415 +{{code language="java"}}{{/code}}
416 +
417 +(% class="box infomessage" %)
418 +(((
419 +**{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
420 +)))
421 +
422 +* **file.addCell(int indexColumn, int indexRow, Object value) ** - создание ячейки в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
423 +* **file.addCell(int indexColumn, Object value) ** - создание ячейки в указанный столбец в конец строки текущего листа таблицы Excel (XLSX, XLS) с указанным значением
424 +
425 +**Пример использования:**
426 +
427 +{{code language="java"}}{{/code}}
428 +
429 +(% class="box infomessage" %)
430 +(((
431 +**{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
432 +)))
433 +
434 +* **file.replaceRow(int indexRow, Object... inp) **
435 +
436 +**Пример использования:**
437 +
438 +{{code language="java"}}{{/code}}
439 +
440 +(% class="box infomessage" %)
441 +(((
442 +**{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
443 +)))
444 +
445 +* **file.sortASC(int indexColumn) **
446 +
447 +**Пример использования:**
448 +
449 +{{code language="java"}}{{/code}}
450 +
451 +(% class="box infomessage" %)
452 +(((
453 +**{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
454 +)))
455 +
456 +* **file.sortDESC(int indexColumn) **
457 +
458 +**Пример использования:**
459 +
460 +{{code language="java"}}{{/code}}
461 +
462 +(% class="box infomessage" %)
463 +(((
464 +**{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
465 +)))
466 +
467 +* **file.saveTempTable(String tablesTempLocation) **
468 +
469 +**Пример использования:**
470 +
471 +{{code language="java"}}{{/code}}
472 +
473 +(% class="box infomessage" %)
474 +(((
475 +**{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
476 +)))
477 +
478 +* **file.xlsxToJSON(int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS) с указанной страницы, с указанным количеством строк в формат JSON
479 +* **file.xlsxToJSON(String tablesTempLocation, int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS), находящегося по указанному пути в формате JSON, с учетом указанной страницы и указанных количество строк
480 +
481 +**Пример использования:**
482 +
483 +{{code language="java"}}{{/code}}
484 +
485 +(% class="box infomessage" %)
486 +(((
487 +**{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
488 +)))
489 +
490 +* **file.getResource() **
491 +
492 +**Пример использования:**
493 +
494 +{{code language="java"}}{{/code}}
495 +
496 +(% class="box infomessage" %)
497 +(((
498 +**{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
499 +)))
500 +
501 +* **file.makeGrandSmetaExelTable() **
502 +
503 +**Пример использования:**
504 +
505 +{{code language="java"}}{{/code}}
506 +
217 217  **Наименование используемых строк row.get:**
218 218  
219 219