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

Last modified by Bimit Administrator on 02.10.2024, 11:55
From version 6.1
edited by Bimit Administrator
on 16.02.2022, 10:04
Change comment: There is no comment for this version
To version 16.1
edited by Bimit Administrator
on 27.08.2024, 09:29
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -11,16 +11,45 @@
11 11  * [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
12 12  * [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
13 13  * [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
14 +* [[insertRow>>path:#_Toc15]] - функция которая вставляет строку на указанную позицию на странице эксель файла
15 +* [[replaceRow>>path:#_Toc16]] - функция которая замещает строку на указанной позицию на странице эксель файла
16 +* [[deleteRow>>path:#_Toc17]] - функция которая удаляет строку с указанной позиции на странице эксель файла
17 +* [[autoSizeColumns>>path:#_Toc18]] - функция установки автоматической ширины колонок страницы эксель файла
14 14  * [[getDocument>>path:#_Toc11]] - получение интерфейса текущего документа XWPFDocument (docx) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFDocument.html), предоставляет полный доступ к инструментарию формирования документа MSWord
15 15  * [[getParagraph>>path:#_Toc12]] - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord
16 16  * [[getWorkbook>>path:#_Toc13]] - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель
17 17  * [[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) для отчета о гранд-смете
18 18  
34 +**Генерация документа с использованием шаблона**
35 +
36 +* [[templateToPdf>>path:#_Toc19]] - генерация pdf документа из шаблона
37 +
38 +**Генерация отчета по коллизиям и атрибутам**
39 +
40 +* [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
41 +* [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
42 +
43 +[[Примеры использования в плагинах>>Примеры использования в плагинах]]
44 +
45 +
19 19  (% class="box infomessage" %)
20 20  (((
21 -**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
48 +**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
22 22  )))
23 23  
51 +* **file.create(формат создаваемого файла)**
52 +
24 24  **Пример использования:**
25 25  
26 26  
... ... @@ -34,8 +34,8 @@
34 34  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
35 35  )))
36 36  
37 -* с базовыми настройками
38 -* с указанием размера шрифта, и указанием жирный/простой
66 +* **file.addTitle(Текст)** - с базовыми настройками
67 +* **file.addTitle(Текст, Размер шрифта, жирный/не жирный)** - с указанием размера шрифта, и указанием жирный/простой
39 39  
40 40  **Примеры использования:**
41 41  
... ... @@ -53,8 +53,8 @@
53 53  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
54 54  )))
55 55  
56 -* с базовыми настройками
57 -* с указанием отступа, размера шрифта, и указанием жирный/простой
85 +* **file.addParagraph("Текст")** - с базовыми настройками
86 +* **file.addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный)** - с указанием отступа, размера шрифта, и указанием жирный/простой
58 58  
59 59  **Примеры использования:**
60 60  
... ... @@ -74,10 +74,11 @@
74 74  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
75 75  )))
76 76  
106 +* **file.addCenterParagraph("текст", размер шрифта, жирный/не жирный)**
107 +
77 77  **Пример использования:**
78 78  
79 79  
80 -
81 81  {{code language="java"}}
82 82  addCenterParagraph("Текст", 10, true)
83 83  {{/code}}
... ... @@ -88,6 +88,8 @@
88 88  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
89 89  )))
90 90  
121 +* **file.addRightParagraph("текст", размер шрифта, жирный/не жирный)**
122 +
91 91  **Пример использования:**
92 92  
93 93  
... ... @@ -101,6 +101,8 @@
101 101  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
102 102  )))
103 103  
136 +* **file.addLeftParagraph("текст", размер шрифта, жирный/не жирный)**
137 +
104 104  **Пример использования:**
105 105  
106 106  
... ... @@ -114,6 +114,8 @@
114 114  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
115 115  )))
116 116  
151 +* **file.addTextBreak()**
152 +
117 117  **Пример использования:**
118 118  
119 119  
... ... @@ -127,8 +127,8 @@
127 127  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
128 128  )))
129 129  
130 -* с указанием размера текста и указанием жирный/простой
131 -* с опциями (file.addText(“Строка, которая появится в файле”))
166 +* **file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)**
167 +* **file.addText(“Строка, которая появится в файле”)**
132 132  
133 133  **Примеры использования:**
134 134  
... ... @@ -143,9 +143,11 @@
143 143  
144 144  (% class="box infomessage" %)
145 145  (((
146 -**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
182 +**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
147 147  )))
148 148  
185 +* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
186 +
149 149  **Пример использования:**
150 150  
151 151  
... ... @@ -156,9 +156,11 @@
156 156  
157 157  (% class="box infomessage" %)
158 158  (((
159 -**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
197 +**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
160 160  )))
161 161  
200 +* **file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)**
201 +
162 162  **Пример использования:**
163 163  
164 164  
... ... @@ -169,6 +169,63 @@
169 169  
170 170  (% class="box infomessage" %)
171 171  (((
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 +(((
172 172  **{{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/)]]
173 173  )))
174 174  
... ... @@ -206,6 +206,196 @@
206 206  {{/code}}
207 207  
208 208  
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="_Toc30"/}}addAreaBreak** - добавление разрыва области PDF документа
376 +)))
377 +
378 +* **file.addAreaBreak() **
379 +
380 +**Пример использования:**
381 +
382 +{{code language="java"}}{{/code}}
383 +
384 +(% class="box infomessage" %)
385 +(((
386 +**{{id name="_Toc31"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
387 +)))
388 +
389 +* **file.addImage(byte[] imageFile) **
390 +
391 +**Пример использования:**
392 +
393 +{{code language="java"}}{{/code}}
394 +
395 +(% class="box infomessage" %)
396 +(((
397 +**{{id name="_Toc32"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
398 +)))
399 +
400 +* **file.addDrawing(byte[] drawingPage, double[][] arr) **
401 +
402 +**Пример использования:**
403 +
404 +{{code language="java"}}{{/code}}
405 +
406 +(% class="box infomessage" %)
407 +(((
408 +**{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
409 +)))
410 +
411 +* **file.addCell(int indexColumn, int indexRow, Object value) ** - создание ячейки в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
412 +* **file.addCell(int indexColumn, Object value) ** - создание ячейки в указанный столбец в конец строки текущего листа таблицы Excel (XLSX, XLS) с указанным значением
413 +
414 +**Пример использования:**
415 +
416 +{{code language="java"}}{{/code}}
417 +
418 +(% class="box infomessage" %)
419 +(((
420 +**{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
421 +)))
422 +
423 +* **file.replaceRow(int indexRow, Object... inp) **
424 +
425 +**Пример использования:**
426 +
427 +{{code language="java"}}{{/code}}
428 +
429 +(% class="box infomessage" %)
430 +(((
431 +**{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
432 +)))
433 +
434 +* **file.sortASC(int indexColumn) **
435 +
436 +**Пример использования:**
437 +
438 +{{code language="java"}}{{/code}}
439 +
440 +(% class="box infomessage" %)
441 +(((
442 +**{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
443 +)))
444 +
445 +* **file.sortDESC(int indexColumn) **
446 +
447 +**Пример использования:**
448 +
449 +{{code language="java"}}{{/code}}
450 +
451 +(% class="box infomessage" %)
452 +(((
453 +**{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
454 +)))
455 +
456 +* **file.saveTempTable(String tablesTempLocation) **
457 +
458 +**Пример использования:**
459 +
460 +{{code language="java"}}{{/code}}
461 +
462 +(% class="box infomessage" %)
463 +(((
464 +**{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
465 +)))
466 +
467 +* **file.xlsxToJSON(int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS) с указанной страницы, с указанным количеством строк в формат JSON
468 +* **file.xlsxToJSON(String tablesTempLocation, int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS), находящегося по указанному пути в формате JSON, с учетом указанной страницы и указанных количество строк
469 +
470 +**Пример использования:**
471 +
472 +{{code language="java"}}{{/code}}
473 +
474 +(% class="box infomessage" %)
475 +(((
476 +**{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
477 +)))
478 +
479 +* **file.getResource() **
480 +
481 +**Пример использования:**
482 +
483 +{{code language="java"}}{{/code}}
484 +
485 +(% class="box infomessage" %)
486 +(((
487 +**{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
488 +)))
489 +
490 +* **file.makeGrandSmetaExelTable() **
491 +
492 +**Пример использования:**
493 +
494 +{{code language="java"}}{{/code}}
495 +
209 209  **Наименование используемых строк row.get:**
210 210  
211 211  
... ... @@ -239,6 +239,7 @@
239 239  (% style="line-height:1.2" %)
240 240  (% style="background-color:#ffffff; color:#000000; font-family:Arial; font-size:11pt; font-style:normal; font-variant:normal; font-weight:400; overflow-wrap:break-word; overflow:hidden; text-decoration:none; white-space:pre-wrap" %)Единицы измерений
241 241  )))
529 +|(% style="border-bottom:1px solid #000000; border-left:1px solid #000000; border-right:1px solid #000000; border-top:1px solid #000000; padding:7px 7px 7px 7px; vertical-align:top" width="NaN" %)unit|(% style="border-bottom:1px solid #000000; border-left:1px solid #000000; border-right:1px solid #000000; border-top:1px solid #000000; padding:7px 7px 7px 7px; vertical-align:top" width="NaN" %)Единица измерения
242 242  |(% style="border-bottom:1px solid #000000; border-left:1px solid #000000; border-right:1px solid #000000; border-top:1px solid #000000; padding:7px 7px 7px 7px; vertical-align:top" width="NaN" %)(((
243 243  (% style="line-height:1.2" %)
244 244  (% style="background-color:#ffffff; color:#000000; font-family:Arial; font-size:11pt; font-style:normal; font-variant:normal; font-weight:400; overflow-wrap:break-word; overflow:hidden; text-decoration:none; white-space:pre-wrap" %)quantityPerUnit
... ... @@ -253,6 +253,7 @@
253 253  (% style="line-height:1.2" %)
254 254  (% style="background-color:#ffffff; color:#000000; font-family:Arial; font-size:11pt; font-style:normal; font-variant:normal; font-weight:400; overflow-wrap:break-word; overflow:hidden; text-decoration:none; white-space:pre-wrap" %)Количество всего
255 255  )))
544 +|(% style="border-bottom:1px solid #000000; border-left:1px solid #000000; border-right:1px solid #000000; border-top:1px solid #000000; padding:7px 7px 7px 7px; vertical-align:top" width="NaN" %)quantity|(% style="border-bottom:1px solid #000000; border-left:1px solid #000000; border-right:1px solid #000000; border-top:1px solid #000000; padding:7px 7px 7px 7px; vertical-align:top" width="NaN" %)Количество
256 256  |(% style="border-bottom:1px solid #000000; border-left:1px solid #000000; border-right:1px solid #000000; border-top:1px solid #000000; padding:7px 7px 7px 7px; vertical-align:top" width="NaN" %)(((
257 257  (% style="line-height:1.2" %)
258 258  (% style="background-color:#ffffff; color:#000000; font-family:Arial; font-size:11pt; font-style:normal; font-variant:normal; font-weight:400; overflow-wrap:break-word; overflow:hidden; text-decoration:none; white-space:pre-wrap" %)priceAll