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

Last modified by Bimit Administrator on 02.10.2024, 11:55

From version 16.5
edited by Bimit Administrator
on 27.08.2024, 10:03
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
... ... @@ -19,9 +19,9 @@
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, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
22 +* [[addAreaBreak>>path:#_Toc19]] - добавление разрыва области PDF документа
23 +* [[addImage>>path:#_Toc20]] - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
24 +* [[addDrawing>>path:#_Toc21]] - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
25 25  * [[addCell>>path:#_Toc22]] - создание ячейки в указанный столбец
26 26  * [[replaceRow>>path:#_Toc23]] - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
27 27  * [[sortASC>>path:#_Toc24]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
... ... @@ -48,7 +48,7 @@
48 48  **{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
49 49  )))
50 50  
51 -* **file.create(формат создаваемого файла)**
51 +* file.create(формат создаваемого файла)
52 52  
53 53  **Пример использования:**
54 54  
... ... @@ -63,8 +63,8 @@
63 63  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
64 64  )))
65 65  
66 -* **file.addTitle(Текст)** - с базовыми настройками
67 -* **file.addTitle(Текст, Размер шрифта, жирный/не жирный)** - с указанием размера шрифта, и указанием жирный/простой
66 +* file.addTitle(Текст) - с базовыми настройками
67 +* file.addTitle(Текст, Размер шрифта, жирный/не жирный) - с указанием размера шрифта, и указанием жирный/простой
68 68  
69 69  **Примеры использования:**
70 70  
... ... @@ -82,8 +82,8 @@
82 82  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
83 83  )))
84 84  
85 -* **file.addParagraph("Текст")** - с базовыми настройками
86 -* **file.addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный)** - с указанием отступа, размера шрифта, и указанием жирный/простой
85 +* addParagraph("Текст") - с базовыми настройками
86 +* addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный) - с указанием отступа, размера шрифта, и указанием жирный/простой
87 87  
88 88  **Примеры использования:**
89 89  
... ... @@ -103,7 +103,7 @@
103 103  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
104 104  )))
105 105  
106 -* **file.addCenterParagraph("текст", размер шрифта, жирный/не жирный)**
106 +* addCenterParagraph("текст", размер шрифта, жирный/не жирный)
107 107  
108 108  **Пример использования:**
109 109  
... ... @@ -118,7 +118,7 @@
118 118  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
119 119  )))
120 120  
121 -* **file.addRightParagraph("текст", размер шрифта, жирный/не жирный)**
121 +* addRightParagraph("текст", размер шрифта, жирный/не жирный)
122 122  
123 123  **Пример использования:**
124 124  
... ... @@ -133,7 +133,7 @@
133 133  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
134 134  )))
135 135  
136 -* **file.addLeftParagraph("текст", размер шрифта, жирный/не жирный)**
136 +* addLeftParagraph("текст", размер шрифта, жирный/не жирный)
137 137  
138 138  **Пример использования:**
139 139  
... ... @@ -148,7 +148,7 @@
148 148  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
149 149  )))
150 150  
151 -* **file.addTextBreak()**
151 +* file.addTextBreak()
152 152  
153 153  **Пример использования:**
154 154  
... ... @@ -163,17 +163,12 @@
163 163  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
164 164  )))
165 165  
166 -* **file.addText(Object objectValue)** - добавление объекта в строковом представлении
167 -* **file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)**
168 -* **file.addText(“Строка, которая появится в файле”)**
169 -* **file.addText(long longValue)** - добавление числа типа long в строковом представлении
170 -* **file.addText(double doubleValue)** - добавление числа типа double в строковом представлении
166 +* file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
167 +* file.addText(“Строка, которая появится в файле”)
171 171  
172 172  **Примеры использования:**
173 173  
174 174  {{code language="java"}}
175 -{{/code}}
176 -{{code language="java"}}
177 177  file.addText("Строка, которая появится в файле"), 10, false)
178 178  {{/code}}
179 179  
... ... @@ -181,19 +181,13 @@
181 181  file.addText("Строка, которая появится в файле")
182 182  {{/code}}
183 183  
184 -{{code language="java"}}
185 -{{/code}}
186 186  
187 -{{code language="java"}}
188 -{{/code}}
189 -
190 -
191 191  (% class="box infomessage" %)
192 192  (((
193 193  **{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
194 194  )))
195 195  
196 -* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
185 +* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
197 197  
198 198  **Пример использования:**
199 199  
... ... @@ -208,8 +208,7 @@
208 208  **{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
209 209  )))
210 210  
211 -* **file.addRow(Object... inp)**
212 -* **file.addRow(Map<Object, Object>... inp)**
200 +* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
213 213  
214 214  **Пример использования:**
215 215  
... ... @@ -218,16 +218,13 @@
218 218  file.addRow( row.get("code"), row.get("title"), row.get("units"), row.get("quantityAll"));
219 219  {{/code}}
220 220  
221 -{{code language="java"}}
222 -{{/code}}
223 223  
224 -
225 225  (% class="box infomessage" %)
226 226  (((
227 227  **{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
228 228  )))
229 229  
230 -* **file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
215 +* file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
231 231  
232 232  **Пример использования:**
233 233  
... ... @@ -241,7 +241,7 @@
241 241  **{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
242 242  )))
243 243  
244 -* **file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
229 +* file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
245 245  
246 246  **Пример использования:**
247 247  
... ... @@ -255,7 +255,7 @@
255 255  **{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
256 256  )))
257 257  
258 -* **file.deleteRow(индекс)**
243 +* file.deleteRow(индекс)
259 259  
260 260  **Пример использования:**
261 261  
... ... @@ -269,8 +269,8 @@
269 269  **{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
270 270  )))
271 271  
272 -* **file.autoSizeColumns()** - для всех колонок на странице
273 -* **file.autoSizeColumns(индекс колонки)** - для конкретной колонки на странице
257 +* file.autoSizeColumns() - для всех колонок на странице
258 +* file.autoSizeColumns(индекс колонки) - для конкретной колонки на странице
274 274  
275 275  **Пример использования:**
276 276  
... ... @@ -323,8 +323,8 @@
323 323  **{{id name="_Toc19"/}}templateToPdf** - генерация pdf документа из шаблона
324 324  )))
325 325  
326 -* **[[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)**
327 -* **file.templateToPdf(template)**
311 +* [[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)
312 +* file.templateToPdf(template)
328 328  
329 329  **Пример использования:**
330 330  
... ... @@ -340,10 +340,10 @@
340 340  **{{id name="_Toc20"/}}collisionsToPdf** - генерация pdf по списку коллизий
341 341  )))
342 342  
343 -* **file.collisionsToPdf(template, list, params):**
344 -* **template** - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
345 -* **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]]
346 -* **params** - необязательный параметр (описание ниже)
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 - необязательный параметр (описание ниже)
347 347  
348 348   Параметры при генерации отчета по коллизиям:
349 349   pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
... ... @@ -383,11 +383,11 @@
383 383  **{{id name="_Toc21"/}}attributesToPdf** - генерация pdf по списку атрибутов
384 384  )))
385 385  
386 -* **file.attributesToPdf(template, list, params)**
371 +* file.attributesToPdf(template, list, params)
387 387  
388 388  (% class="box infomessage" %)
389 389  (((
390 -**{{id name="_Toc30"/}}addAreaBreak** - добавление разрыва области PDF документа
375 +**{{id name="_Toc19"/}}addAreaBreak** - добавление разрыва области PDF документа
391 391  )))
392 392  
393 393  * **file.addAreaBreak() **
... ... @@ -394,11 +394,13 @@
394 394  
395 395  **Пример использования:**
396 396  
397 -{{code language="java"}}{{/code}}
382 +{{code language="java"}}
398 398  
384 +{{/code}}
385 +
399 399  (% class="box infomessage" %)
400 400  (((
401 -**{{id name="_Toc31"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
388 +**{{id name="_Toc20"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
402 402  )))
403 403  
404 404  * **file.addImage(byte[] imageFile) **
... ... @@ -405,11 +405,13 @@
405 405  
406 406  **Пример использования:**
407 407  
408 -{{code language="java"}}{{/code}}
395 +{{code language="java"}}
409 409  
397 +{{/code}}
398 +
410 410  (% class="box infomessage" %)
411 411  (((
412 -**{{id name="_Toc32"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
401 +**{{id name="_Toc21"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
413 413  )))
414 414  
415 415  * **file.addDrawing(byte[] drawingPage, double[][] arr) **
... ... @@ -416,8 +416,10 @@
416 416  
417 417  **Пример использования:**
418 418  
419 -{{code language="java"}}{{/code}}
408 +{{code language="java"}}
420 420  
410 +{{/code}}
411 +
421 421  (% class="box infomessage" %)
422 422  (((
423 423  **{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
... ... @@ -428,8 +428,10 @@
428 428  
429 429  **Пример использования:**
430 430  
431 -{{code language="java"}}{{/code}}
422 +{{code language="java"}}
432 432  
424 +{{/code}}
425 +
433 433  (% class="box infomessage" %)
434 434  (((
435 435  **{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
... ... @@ -439,8 +439,10 @@
439 439  
440 440  **Пример использования:**
441 441  
442 -{{code language="java"}}{{/code}}
435 +{{code language="java"}}
443 443  
437 +{{/code}}
438 +
444 444  (% class="box infomessage" %)
445 445  (((
446 446  **{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
... ... @@ -450,8 +450,10 @@
450 450  
451 451  **Пример использования:**
452 452  
453 -{{code language="java"}}{{/code}}
448 +{{code language="java"}}
454 454  
450 +{{/code}}
451 +
455 455  (% class="box infomessage" %)
456 456  (((
457 457  **{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
... ... @@ -461,8 +461,10 @@
461 461  
462 462  **Пример использования:**
463 463  
464 -{{code language="java"}}{{/code}}
461 +{{code language="java"}}
465 465  
463 +{{/code}}
464 +
466 466  (% class="box infomessage" %)
467 467  (((
468 468  **{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
... ... @@ -472,8 +472,10 @@
472 472  
473 473  **Пример использования:**
474 474  
475 -{{code language="java"}}{{/code}}
474 +{{code language="java"}}
476 476  
476 +{{/code}}
477 +
477 477  (% class="box infomessage" %)
478 478  (((
479 479  **{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
... ... @@ -484,8 +484,10 @@
484 484  
485 485  **Пример использования:**
486 486  
487 -{{code language="java"}}{{/code}}
488 +{{code language="java"}}
488 488  
490 +{{/code}}
491 +
489 489  (% class="box infomessage" %)
490 490  (((
491 491  **{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
... ... @@ -495,8 +495,10 @@
495 495  
496 496  **Пример использования:**
497 497  
498 -{{code language="java"}}{{/code}}
501 +{{code language="java"}}
499 499  
503 +{{/code}}
504 +
500 500  (% class="box infomessage" %)
501 501  (((
502 502  **{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
... ... @@ -506,8 +506,10 @@
506 506  
507 507  **Пример использования:**
508 508  
509 -{{code language="java"}}{{/code}}
514 +{{code language="java"}}
510 510  
516 +{{/code}}
517 +
511 511  **Наименование используемых строк row.get:**
512 512  
513 513