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

Last modified by Bimit Administrator on 02.10.2024, 11:55

From version 16.2
edited by Bimit Administrator
on 27.08.2024, 09:50
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,10 +163,8 @@
163 163  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
164 164  )))
165 165  
166 -* **file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)**
167 -* **file.addText(“Строка, которая появится в файле”)**
168 -* **file.addText(long longValue)** - добавление числа типа long в строковом представлении
169 -* **file.addText(double doubleValue)** - добавление числа типа double в строковом представлении
166 +* file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
167 +* file.addText(“Строка, которая появится в файле”)
170 170  
171 171  **Примеры использования:**
172 172  
... ... @@ -178,19 +178,13 @@
178 178  file.addText("Строка, которая появится в файле")
179 179  {{/code}}
180 180  
181 -{{code language="java"}}
182 -{{/code}}
183 183  
184 -{{code language="java"}}
185 -{{/code}}
186 -
187 -
188 188  (% class="box infomessage" %)
189 189  (((
190 190  **{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
191 191  )))
192 192  
193 -* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
185 +* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
194 194  
195 195  **Пример использования:**
196 196  
... ... @@ -205,7 +205,7 @@
205 205  **{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
206 206  )))
207 207  
208 -* **file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)**
200 +* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
209 209  
210 210  **Пример использования:**
211 211  
... ... @@ -220,7 +220,7 @@
220 220  **{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
221 221  )))
222 222  
223 -* **file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
215 +* file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
224 224  
225 225  **Пример использования:**
226 226  
... ... @@ -234,7 +234,7 @@
234 234  **{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
235 235  )))
236 236  
237 -* **file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
229 +* file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
238 238  
239 239  **Пример использования:**
240 240  
... ... @@ -248,7 +248,7 @@
248 248  **{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
249 249  )))
250 250  
251 -* **file.deleteRow(индекс)**
243 +* file.deleteRow(индекс)
252 252  
253 253  **Пример использования:**
254 254  
... ... @@ -262,8 +262,8 @@
262 262  **{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
263 263  )))
264 264  
265 -* **file.autoSizeColumns()** - для всех колонок на странице
266 -* **file.autoSizeColumns(индекс колонки)** - для конкретной колонки на странице
257 +* file.autoSizeColumns() - для всех колонок на странице
258 +* file.autoSizeColumns(индекс колонки) - для конкретной колонки на странице
267 267  
268 268  **Пример использования:**
269 269  
... ... @@ -316,8 +316,8 @@
316 316  **{{id name="_Toc19"/}}templateToPdf** - генерация pdf документа из шаблона
317 317  )))
318 318  
319 -* **[[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)**
320 -* **file.templateToPdf(template)**
311 +* [[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, данные)
312 +* file.templateToPdf(template)
321 321  
322 322  **Пример использования:**
323 323  
... ... @@ -333,10 +333,10 @@
333 333  **{{id name="_Toc20"/}}collisionsToPdf** - генерация pdf по списку коллизий
334 334  )))
335 335  
336 -* **file.collisionsToPdf(template, list, params):**
337 -* **template** - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
338 -* **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]]
339 -* **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 - необязательный параметр (описание ниже)
340 340  
341 341   Параметры при генерации отчета по коллизиям:
342 342   pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
... ... @@ -376,11 +376,11 @@
376 376  **{{id name="_Toc21"/}}attributesToPdf** - генерация pdf по списку атрибутов
377 377  )))
378 378  
379 -* **file.attributesToPdf(template, list, params)**
371 +* file.attributesToPdf(template, list, params)
380 380  
381 381  (% class="box infomessage" %)
382 382  (((
383 -**{{id name="_Toc30"/}}addAreaBreak** - добавление разрыва области PDF документа
375 +**{{id name="_Toc19"/}}addAreaBreak** - добавление разрыва области PDF документа
384 384  )))
385 385  
386 386  * **file.addAreaBreak() **
... ... @@ -387,11 +387,13 @@
387 387  
388 388  **Пример использования:**
389 389  
390 -{{code language="java"}}{{/code}}
382 +{{code language="java"}}
391 391  
384 +{{/code}}
385 +
392 392  (% class="box infomessage" %)
393 393  (((
394 -**{{id name="_Toc31"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
388 +**{{id name="_Toc20"/}}addImage** - добавление изображения в документ Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
395 395  )))
396 396  
397 397  * **file.addImage(byte[] imageFile) **
... ... @@ -398,11 +398,13 @@
398 398  
399 399  **Пример использования:**
400 400  
401 -{{code language="java"}}{{/code}}
395 +{{code language="java"}}
402 402  
397 +{{/code}}
398 +
403 403  (% class="box infomessage" %)
404 404  (((
405 -**{{id name="_Toc32"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
401 +**{{id name="_Toc21"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
406 406  )))
407 407  
408 408  * **file.addDrawing(byte[] drawingPage, double[][] arr) **
... ... @@ -409,8 +409,10 @@
409 409  
410 410  **Пример использования:**
411 411  
412 -{{code language="java"}}{{/code}}
408 +{{code language="java"}}
413 413  
410 +{{/code}}
411 +
414 414  (% class="box infomessage" %)
415 415  (((
416 416  **{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
... ... @@ -421,8 +421,10 @@
421 421  
422 422  **Пример использования:**
423 423  
424 -{{code language="java"}}{{/code}}
422 +{{code language="java"}}
425 425  
424 +{{/code}}
425 +
426 426  (% class="box infomessage" %)
427 427  (((
428 428  **{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
... ... @@ -432,8 +432,10 @@
432 432  
433 433  **Пример использования:**
434 434  
435 -{{code language="java"}}{{/code}}
435 +{{code language="java"}}
436 436  
437 +{{/code}}
438 +
437 437  (% class="box infomessage" %)
438 438  (((
439 439  **{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
... ... @@ -443,8 +443,10 @@
443 443  
444 444  **Пример использования:**
445 445  
446 -{{code language="java"}}{{/code}}
448 +{{code language="java"}}
447 447  
450 +{{/code}}
451 +
448 448  (% class="box infomessage" %)
449 449  (((
450 450  **{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
... ... @@ -454,8 +454,10 @@
454 454  
455 455  **Пример использования:**
456 456  
457 -{{code language="java"}}{{/code}}
461 +{{code language="java"}}
458 458  
463 +{{/code}}
464 +
459 459  (% class="box infomessage" %)
460 460  (((
461 461  **{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
... ... @@ -465,8 +465,10 @@
465 465  
466 466  **Пример использования:**
467 467  
468 -{{code language="java"}}{{/code}}
474 +{{code language="java"}}
469 469  
476 +{{/code}}
477 +
470 470  (% class="box infomessage" %)
471 471  (((
472 472  **{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
... ... @@ -477,8 +477,10 @@
477 477  
478 478  **Пример использования:**
479 479  
480 -{{code language="java"}}{{/code}}
488 +{{code language="java"}}
481 481  
490 +{{/code}}
491 +
482 482  (% class="box infomessage" %)
483 483  (((
484 484  **{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
... ... @@ -488,8 +488,10 @@
488 488  
489 489  **Пример использования:**
490 490  
491 -{{code language="java"}}{{/code}}
501 +{{code language="java"}}
492 492  
503 +{{/code}}
504 +
493 493  (% class="box infomessage" %)
494 494  (((
495 495  **{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
... ... @@ -499,8 +499,10 @@
499 499  
500 500  **Пример использования:**
501 501  
502 -{{code language="java"}}{{/code}}
514 +{{code language="java"}}
503 503  
516 +{{/code}}
517 +
504 504  **Наименование используемых строк row.get:**
505 505  
506 506