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

Last modified by Bimit Administrator on 02.10.2024, 11:55
From version 16.6
edited by Bimit Administrator
on 27.08.2024, 10:07
Change comment: There is no comment for this version
To version 7.1
edited by Bimit Administrator
on 16.02.2022, 15:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,7 +2,6 @@
2 2  В нем доступны следующий функции:
3 3  
4 4  * [[create>>path:#_Toc1]] - функция конструктор, создает и подготавливает файл для приема данных
5 -* [[setStyle>>path:#_Toc1]] - применение указанного стиля к тексту указанной ячейки Excel файла при работе с отчетом
6 6  * [[addTitle>>path:#_Toc2]] - добавление заголовка в документ MS Word (DOCX)
7 7  * [[addParagraph>>path:#_Toc3]] - функция создания нового параграфа в документе MS Word (DOCX)
8 8  * [[addCenterParagraph>>path:#_Toc4]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
... ... @@ -12,45 +12,16 @@
12 12  * [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
13 13  * [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
14 14  * [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
15 -* [[insertRow>>path:#_Toc15]] - функция которая вставляет строку на указанную позицию на странице эксель файла
16 -* [[replaceRow>>path:#_Toc16]] - функция которая замещает строку на указанной позицию на странице эксель файла
17 -* [[deleteRow>>path:#_Toc17]] - функция которая удаляет строку с указанной позиции на странице эксель файла
18 -* [[autoSizeColumns>>path:#_Toc18]] - функция установки автоматической ширины колонок страницы эксель файла
19 19  * [[getDocument>>path:#_Toc11]] - получение интерфейса текущего документа XWPFDocument (docx) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFDocument.html), предоставляет полный доступ к инструментарию формирования документа MSWord
20 20  * [[getParagraph>>path:#_Toc12]] - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord
21 21  * [[getWorkbook>>path:#_Toc13]] - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель
22 22  * [[getSheet>>path:#_Toc14]] - получение интерфейса текущей страницы с таблицей (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Sheet.html) документа таблицы эксель
23 -* [[addAreaBreak>>path:#_Toc30]] - добавление разрыва области PDF документа
24 -* [[addImage>>path:#_Toc31]] - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
25 -* [[addDrawing>>path:#_Toc32]] - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
26 -* [[addCell>>path:#_Toc22]] - создание ячейки в указанный столбец
27 -* [[replaceRow>>path:#_Toc23]] - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
28 -* [[sortASC>>path:#_Toc24]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
29 -* [[sortDESC>>path:#_Toc25]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
30 -* [[saveTempTable>>path:#_Toc26]] - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
31 -* [[xlsxToJSON>>path:#_Toc27]] - преобразование содержимого документа Excel (XLSX, XLS)
32 -* [[getResource>>path:#_Toc28]] - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
33 -* [[makeGrandSmetaExelTable>>path:#_Toc29]] - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
34 34  
35 -**Генерация документа с использованием шаблона**
36 -
37 -* [[templateToPdf>>path:#_Toc19]] - генерация pdf документа из шаблона
38 -
39 -**Генерация отчета по коллизиям и атрибутам**
40 -
41 -* [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
42 -* [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
43 -
44 -[[Примеры использования в плагинах>>Примеры использования в плагинах]]
45 -
46 -
47 47  (% class="box infomessage" %)
48 48  (((
49 -**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
21 +**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
50 50  )))
51 51  
52 -* **file.create(формат создаваемого файла)**
53 -
54 54  **Пример использования:**
55 55  
56 56  
... ... @@ -61,24 +61,11 @@
61 61  
62 62  (% class="box infomessage" %)
63 63  (((
64 -**{{id name="_Toc33"/}}setStyle** - применение указанного стиля к тексту указанной ячейки Excel файла при работе с отчетом
65 -)))
66 -
67 -* **file.setStyle (Sheet sheet, Workbook workbook, int indexRow, int indexColumn, ExcelStyleManager)**
68 -
69 -**Пример использования:**
70 -
71 -{{code language="java"}}
72 -{{/code}}
73 -
74 -
75 -(% class="box infomessage" %)
76 -(((
77 77  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
78 78  )))
79 79  
80 -* **file.addTitle(Текст)** - с базовыми настройками
81 -* **file.addTitle(Текст, Размер шрифта, жирный/не жирный)** - с указанием размера шрифта, и указанием жирный/простой
37 +* с базовыми настройками
38 +* с указанием размера шрифта, и указанием жирный/простой
82 82  
83 83  **Примеры использования:**
84 84  
... ... @@ -96,8 +96,8 @@
96 96  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
97 97  )))
98 98  
99 -* **file.addParagraph("Текст")** - с базовыми настройками
100 -* **file.addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный)** - с указанием отступа, размера шрифта, и указанием жирный/простой
56 +* с базовыми настройками
57 +* с указанием отступа, размера шрифта, и указанием жирный/простой
101 101  
102 102  **Примеры использования:**
103 103  
... ... @@ -117,11 +117,10 @@
117 117  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
118 118  )))
119 119  
120 -* **file.addCenterParagraph("текст", размер шрифта, жирный/не жирный)**
121 -
122 122  **Пример использования:**
123 123  
124 124  
80 +
125 125  {{code language="java"}}
126 126  addCenterParagraph("Текст", 10, true)
127 127  {{/code}}
... ... @@ -132,8 +132,6 @@
132 132  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
133 133  )))
134 134  
135 -* **file.addRightParagraph("текст", размер шрифта, жирный/не жирный)**
136 -
137 137  **Пример использования:**
138 138  
139 139  
... ... @@ -147,8 +147,6 @@
147 147  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
148 148  )))
149 149  
150 -* **file.addLeftParagraph("текст", размер шрифта, жирный/не жирный)**
151 -
152 152  **Пример использования:**
153 153  
154 154  
... ... @@ -162,8 +162,6 @@
162 162  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
163 163  )))
164 164  
165 -* **file.addTextBreak()**
166 -
167 167  **Пример использования:**
168 168  
169 169  
... ... @@ -177,17 +177,12 @@
177 177  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
178 178  )))
179 179  
180 -* **file.addText(Object objectValue)** - добавление объекта в строковом представлении
181 -* **file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)**
182 -* **file.addText(“Строка, которая появится в файле”)**
183 -* **file.addText(long longValue)** - добавление числа типа long в строковом представлении
184 -* **file.addText(double doubleValue)** - добавление числа типа double в строковом представлении
130 +* с указанием размера текста и указанием жирный/простой
131 +* с опциями (file.addText(“Строка, которая появится в файле”))
185 185  
186 186  **Примеры использования:**
187 187  
188 188  {{code language="java"}}
189 -{{/code}}
190 -{{code language="java"}}
191 191  file.addText("Строка, которая появится в файле"), 10, false)
192 192  {{/code}}
193 193  
... ... @@ -195,20 +195,12 @@
195 195  file.addText("Строка, которая появится в файле")
196 196  {{/code}}
197 197  
198 -{{code language="java"}}
199 -{{/code}}
200 200  
201 -{{code language="java"}}
202 -{{/code}}
203 -
204 -
205 205  (% class="box infomessage" %)
206 206  (((
207 -**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
146 +**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
208 208  )))
209 209  
210 -* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
211 -
212 212  **Пример использования:**
213 213  
214 214  
... ... @@ -219,12 +219,9 @@
219 219  
220 220  (% class="box infomessage" %)
221 221  (((
222 -**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
159 +**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
223 223  )))
224 224  
225 -* **file.addRow(Object... inp)**
226 -* **file.addRow(Map<Object, Object>... inp)**
227 -
228 228  **Пример использования:**
229 229  
230 230  
... ... @@ -232,69 +232,9 @@
232 232  file.addRow( row.get("code"), row.get("title"), row.get("units"), row.get("quantityAll"));
233 233  {{/code}}
234 234  
235 -{{code language="java"}}
236 -{{/code}}
237 237  
238 -
239 239  (% class="box infomessage" %)
240 240  (((
241 -**{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
242 -)))
243 -
244 -* **file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
245 -
246 -**Пример использования:**
247 -
248 -{{code language="java"}}
249 -file.insertRow(6, "Вставленная строка", 1 , 2.453, new Date(), Calendar.getInstance());
250 -{{/code}}
251 -
252 -
253 -(% class="box infomessage" %)
254 -(((
255 -**{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
256 -)))
257 -
258 -* **file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
259 -
260 -**Пример использования:**
261 -
262 -{{code language="java"}}
263 -file.replaceRow(7, "Замещенная строка", 4 , 5.678, new Date(), Calendar.getInstance());
264 -{{/code}}
265 -
266 -
267 -(% class="box infomessage" %)
268 -(((
269 -**{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
270 -)))
271 -
272 -* **file.deleteRow(индекс)**
273 -
274 -**Пример использования:**
275 -
276 -{{code language="java"}}
277 -file.deleteRow(3);
278 -{{/code}}
279 -
280 -
281 -(% class="box infomessage" %)
282 -(((
283 -**{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
284 -)))
285 -
286 -* **file.autoSizeColumns()** - для всех колонок на странице
287 -* **file.autoSizeColumns(индекс колонки)** - для конкретной колонки на странице
288 -
289 -**Пример использования:**
290 -
291 -{{code language="java"}}
292 -file.autoSizeColumns()
293 -{{/code}}
294 -
295 -
296 -(% class="box infomessage" %)
297 -(((
298 298  **{{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/)]]
299 299  )))
300 300  
... ... @@ -332,196 +332,6 @@
332 332  {{/code}}
333 333  
334 334  
335 -(% class="box infomessage" %)
336 -(((
337 -**{{id name="_Toc19"/}}templateToPdf** - генерация pdf документа из шаблона
338 -)))
339 -
340 -* **[[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)**
341 -* **file.templateToPdf(template)**
342 -
343 -**Пример использования:**
344 -
345 -{{code language="java"}}
346 -def project = bim.getProject()
347 -template.add("project", project)
348 -file.templateToPdf(template)
349 -{{/code}}
350 -
351 -
352 -(% class="box infomessage" %)
353 -(((
354 -**{{id name="_Toc20"/}}collisionsToPdf** - генерация pdf по списку коллизий
355 -)))
356 -
357 -* **file.collisionsToPdf(template, list, params):**
358 -* **template** - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
359 -* **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]]
360 -* **params** - необязательный параметр (описание ниже)
361 -
362 - Параметры при генерации отчета по коллизиям:
363 - pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
364 - fontSize - int значение размера шрифта (в pt)
365 -
366 - **Пример использования:**
367 -
368 -{{code language="java"}}
369 - def param = [:]
370 - param.add("pageSize", 3)
371 - param.add("fontSize", 12)
372 -{{/code}}
373 -
374 - По умолчанию параметры принимают следующие значения:
375 - pageSize - 4
376 - fontSize - 8
377 -
378 -
379 -**Пример использования:**
380 -
381 -{{code language="java"}}
382 -def collisionList = bim.getCollisionsForReport()
383 - def param = [:]
384 - param.add("pageSize", 3)
385 - param.add("fontSize", 12)
386 - file.collisionsToPdf(template, collisionList, param)
387 -{{/code}}
388 -
389 -{{code language="java"}}
390 - def collisionList = bim.getCollisionsForReport()
391 - file.collisionsToPdf(collisionList)
392 -{{/code}}
393 -
394 -
395 -(% class="box infomessage" %)
396 -(((
397 -**{{id name="_Toc21"/}}attributesToPdf** - генерация pdf по списку атрибутов
398 -)))
399 -
400 -* **file.attributesToPdf(template, list, params)**
401 -
402 -(% class="box infomessage" %)
403 -(((
404 -**{{id name="_Toc30"/}}addAreaBreak** - добавление разрыва области PDF документа
405 -)))
406 -
407 -* **file.addAreaBreak() **
408 -
409 -**Пример использования:**
410 -
411 -{{code language="java"}}{{/code}}
412 -
413 -(% class="box infomessage" %)
414 -(((
415 -**{{id name="_Toc31"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
416 -)))
417 -
418 -* **file.addImage(byte[] imageFile) **
419 -
420 -**Пример использования:**
421 -
422 -{{code language="java"}}{{/code}}
423 -
424 -(% class="box infomessage" %)
425 -(((
426 -**{{id name="_Toc32"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
427 -)))
428 -
429 -* **file.addDrawing(byte[] drawingPage, double[][] arr) **
430 -
431 -**Пример использования:**
432 -
433 -{{code language="java"}}{{/code}}
434 -
435 -(% class="box infomessage" %)
436 -(((
437 -**{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
438 -)))
439 -
440 -* **file.addCell(int indexColumn, int indexRow, Object value) ** - создание ячейки в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
441 -* **file.addCell(int indexColumn, Object value) ** - создание ячейки в указанный столбец в конец строки текущего листа таблицы Excel (XLSX, XLS) с указанным значением
442 -
443 -**Пример использования:**
444 -
445 -{{code language="java"}}{{/code}}
446 -
447 -(% class="box infomessage" %)
448 -(((
449 -**{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
450 -)))
451 -
452 -* **file.replaceRow(int indexRow, Object... inp) **
453 -
454 -**Пример использования:**
455 -
456 -{{code language="java"}}{{/code}}
457 -
458 -(% class="box infomessage" %)
459 -(((
460 -**{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
461 -)))
462 -
463 -* **file.sortASC(int indexColumn) **
464 -
465 -**Пример использования:**
466 -
467 -{{code language="java"}}{{/code}}
468 -
469 -(% class="box infomessage" %)
470 -(((
471 -**{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
472 -)))
473 -
474 -* **file.sortDESC(int indexColumn) **
475 -
476 -**Пример использования:**
477 -
478 -{{code language="java"}}{{/code}}
479 -
480 -(% class="box infomessage" %)
481 -(((
482 -**{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
483 -)))
484 -
485 -* **file.saveTempTable(String tablesTempLocation) **
486 -
487 -**Пример использования:**
488 -
489 -{{code language="java"}}{{/code}}
490 -
491 -(% class="box infomessage" %)
492 -(((
493 -**{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
494 -)))
495 -
496 -* **file.xlsxToJSON(int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS) с указанной страницы, с указанным количеством строк в формат JSON
497 -* **file.xlsxToJSON(String tablesTempLocation, int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS), находящегося по указанному пути в формате JSON, с учетом указанной страницы и указанных количество строк
498 -
499 -**Пример использования:**
500 -
501 -{{code language="java"}}{{/code}}
502 -
503 -(% class="box infomessage" %)
504 -(((
505 -**{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
506 -)))
507 -
508 -* **file.getResource() **
509 -
510 -**Пример использования:**
511 -
512 -{{code language="java"}}{{/code}}
513 -
514 -(% class="box infomessage" %)
515 -(((
516 -**{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
517 -)))
518 -
519 -* **file.makeGrandSmetaExelTable() **
520 -
521 -**Пример использования:**
522 -
523 -{{code language="java"}}{{/code}}
524 -
525 525  **Наименование используемых строк row.get:**
526 526  
527 527