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 15.2
edited by Bimit Administrator
on 21.06.2024, 15:16
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:#_Toc19]] - добавление разрыва области PDF документа
23 +* [[addImage>>path:#_Toc20]] - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
24 +* [[addDrawing>>path:#_Toc21]] - добавление чертежа в документ 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 +* addParagraph("Текст") - с базовыми настройками
86 +* 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 +* 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 +* 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 +* 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,8 +135,8 @@
135 135  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
136 136  )))
137 137  
138 -* с указанием размера текста и указанием жирный/простой
139 -* с опциями (file.addText(“Строка, которая появится в файле”))
166 +* file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
167 +* file.addText(“Строка, которая появится в файле”)
140 140  
141 141  **Примеры использования:**
142 142  
... ... @@ -151,9 +151,11 @@
151 151  
152 152  (% class="box infomessage" %)
153 153  (((
154 -**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
182 +**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
155 155  )))
156 156  
185 +* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
186 +
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”))
197 +**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
168 168  )))
169 169  
200 +* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
201 +
170 170  **Пример использования:**
171 171  
172 172  
... ... @@ -177,6 +177,63 @@
177 177  
178 178  (% class="box infomessage" %)
179 179  (((
212 +**{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
213 +)))
214 +
215 +* file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
216 +
217 +**Пример использования:**
218 +
219 +{{code language="java"}}
220 +file.insertRow(6, "Вставленная строка", 1 , 2.453, new Date(), Calendar.getInstance());
221 +{{/code}}
222 +
223 +
224 +(% class="box infomessage" %)
225 +(((
226 +**{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
227 +)))
228 +
229 +* file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
230 +
231 +**Пример использования:**
232 +
233 +{{code language="java"}}
234 +file.replaceRow(7, "Замещенная строка", 4 , 5.678, new Date(), Calendar.getInstance());
235 +{{/code}}
236 +
237 +
238 +(% class="box infomessage" %)
239 +(((
240 +**{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
241 +)))
242 +
243 +* file.deleteRow(индекс)
244 +
245 +**Пример использования:**
246 +
247 +{{code language="java"}}
248 +file.deleteRow(3);
249 +{{/code}}
250 +
251 +
252 +(% class="box infomessage" %)
253 +(((
254 +**{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
255 +)))
256 +
257 +* file.autoSizeColumns() - для всех колонок на странице
258 +* file.autoSizeColumns(индекс колонки) - для конкретной колонки на странице
259 +
260 +**Пример использования:**
261 +
262 +{{code language="java"}}
263 +file.autoSizeColumns()
264 +{{/code}}
265 +
266 +
267 +(% class="box infomessage" %)
268 +(((
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,218 @@
214 214  {{/code}}
215 215  
216 216  
306 +(% class="box infomessage" %)
307 +(((
308 +**{{id name="_Toc19"/}}templateToPdf** - генерация pdf документа из шаблона
309 +)))
310 +
311 +* [[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)
312 +* file.templateToPdf(template)
313 +
314 +**Пример использования:**
315 +
316 +{{code language="java"}}
317 +def project = bim.getProject()
318 +template.add("project", project)
319 +file.templateToPdf(template)
320 +{{/code}}
321 +
322 +
323 +(% class="box infomessage" %)
324 +(((
325 +**{{id name="_Toc20"/}}collisionsToPdf** - генерация pdf по списку коллизий
326 +)))
327 +
328 +* file.collisionsToPdf(template, list, params):
329 +* template - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
330 +* 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]]
331 +* params - необязательный параметр (описание ниже)
332 +
333 + Параметры при генерации отчета по коллизиям:
334 + pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
335 + fontSize - int значение размера шрифта (в pt)
336 +
337 + **Пример использования:**
338 +
339 +{{code language="java"}}
340 + def param = [:]
341 + param.add("pageSize", 3)
342 + param.add("fontSize", 12)
343 +{{/code}}
344 +
345 + По умолчанию параметры принимают следующие значения:
346 + pageSize - 4
347 + fontSize - 8
348 +
349 +
350 +**Пример использования:**
351 +
352 +{{code language="java"}}
353 +def collisionList = bim.getCollisionsForReport()
354 + def param = [:]
355 + param.add("pageSize", 3)
356 + param.add("fontSize", 12)
357 + file.collisionsToPdf(template, collisionList, param)
358 +{{/code}}
359 +
360 +{{code language="java"}}
361 + def collisionList = bim.getCollisionsForReport()
362 + file.collisionsToPdf(collisionList)
363 +{{/code}}
364 +
365 +
366 +(% class="box infomessage" %)
367 +(((
368 +**{{id name="_Toc21"/}}attributesToPdf** - генерация pdf по списку атрибутов
369 +)))
370 +
371 +* file.attributesToPdf(template, list, params)
372 +
373 +(% class="box infomessage" %)
374 +(((
375 +**{{id name="_Toc19"/}}addAreaBreak** - добавление разрыва области PDF документа
376 +)))
377 +
378 +* **file.addAreaBreak() **
379 +
380 +**Пример использования:**
381 +
382 +{{code language="java"}}
383 +
384 +{{/code}}
385 +
386 +(% class="box infomessage" %)
387 +(((
388 +**{{id name="_Toc20"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
389 +)))
390 +
391 +* **file.addImage(byte[] imageFile) **
392 +
393 +**Пример использования:**
394 +
395 +{{code language="java"}}
396 +
397 +{{/code}}
398 +
399 +(% class="box infomessage" %)
400 +(((
401 +**{{id name="_Toc21"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
402 +)))
403 +
404 +* **file.addDrawing(byte[] drawingPage, double[][] arr) **
405 +
406 +**Пример использования:**
407 +
408 +{{code language="java"}}
409 +
410 +{{/code}}
411 +
412 +(% class="box infomessage" %)
413 +(((
414 +**{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
415 +)))
416 +
417 +* **file.addCell(int indexColumn, int indexRow, Object value) ** - создание ячейки в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
418 +* **file.addCell(int indexColumn, Object value) ** - создание ячейки в указанный столбец в конец строки текущего листа таблицы Excel (XLSX, XLS) с указанным значением
419 +
420 +**Пример использования:**
421 +
422 +{{code language="java"}}
423 +
424 +{{/code}}
425 +
426 +(% class="box infomessage" %)
427 +(((
428 +**{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
429 +)))
430 +
431 +* **file.replaceRow(int indexRow, Object... inp) **
432 +
433 +**Пример использования:**
434 +
435 +{{code language="java"}}
436 +
437 +{{/code}}
438 +
439 +(% class="box infomessage" %)
440 +(((
441 +**{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
442 +)))
443 +
444 +* **file.sortASC(int indexColumn) **
445 +
446 +**Пример использования:**
447 +
448 +{{code language="java"}}
449 +
450 +{{/code}}
451 +
452 +(% class="box infomessage" %)
453 +(((
454 +**{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
455 +)))
456 +
457 +* **file.sortDESC(int indexColumn) **
458 +
459 +**Пример использования:**
460 +
461 +{{code language="java"}}
462 +
463 +{{/code}}
464 +
465 +(% class="box infomessage" %)
466 +(((
467 +**{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
468 +)))
469 +
470 +* **file.saveTempTable(String tablesTempLocation) **
471 +
472 +**Пример использования:**
473 +
474 +{{code language="java"}}
475 +
476 +{{/code}}
477 +
478 +(% class="box infomessage" %)
479 +(((
480 +**{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
481 +)))
482 +
483 +* **file.xlsxToJSON(int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS) с указанной страницы, с указанным количеством строк в формат JSON
484 +* **file.xlsxToJSON(String tablesTempLocation, int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS), находящегося по указанному пути в формате JSON, с учетом указанной страницы и указанных количество строк
485 +
486 +**Пример использования:**
487 +
488 +{{code language="java"}}
489 +
490 +{{/code}}
491 +
492 +(% class="box infomessage" %)
493 +(((
494 +**{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
495 +)))
496 +
497 +* **file.getResource() **
498 +
499 +**Пример использования:**
500 +
501 +{{code language="java"}}
502 +
503 +{{/code}}
504 +
505 +(% class="box infomessage" %)
506 +(((
507 +**{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
508 +)))
509 +
510 +* **file.makeGrandSmetaExelTable() **
511 +
512 +**Пример использования:**
513 +
514 +{{code language="java"}}
515 +
516 +{{/code}}
517 +
217 217  **Наименование используемых строк row.get:**
218 218  
219 219