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

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

Summary

Details

Page properties
Content
... ... @@ -11,34 +11,16 @@
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]] - функция установки автоматической ширины колонок страницы эксель файла
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 22  
23 -**Генерация документа с использованием шаблона**
24 -
25 -* [[templateToPdf>>path:#_Toc19]] - генерация pdf документа из шаблона
26 -
27 -**Генерация отчета по коллизиям и атрибутам**
28 -
29 -* [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
30 -* [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
31 -
32 -[[Примеры использования в плагинах>>Примеры использования в плагинах]]
33 -
34 -
35 35  (% class="box infomessage" %)
36 36  (((
37 -**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
21 +**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
38 38  )))
39 39  
40 -* file.create(формат создаваемого файла)
41 -
42 42  **Пример использования:**
43 43  
44 44  
... ... @@ -52,8 +52,8 @@
52 52  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
53 53  )))
54 54  
55 -* file.addTitle(Текст) - с базовыми настройками
56 -* file.addTitle(Текст, Размер шрифта, жирный/не жирный) - с указанием размера шрифта, и указанием жирный/простой
37 +* с базовыми настройками
38 +* с указанием размера шрифта, и указанием жирный/простой
57 57  
58 58  **Примеры использования:**
59 59  
... ... @@ -71,8 +71,8 @@
71 71  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
72 72  )))
73 73  
74 -* addParagraph("Текст") - с базовыми настройками
75 -* addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный) - с указанием отступа, размера шрифта, и указанием жирный/простой
56 +* с базовыми настройками
57 +* с указанием отступа, размера шрифта, и указанием жирный/простой
76 76  
77 77  **Примеры использования:**
78 78  
... ... @@ -92,11 +92,10 @@
92 92  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
93 93  )))
94 94  
95 -* addCenterParagraph("текст", размер шрифта, жирный/не жирный)
96 -
97 97  **Пример использования:**
98 98  
99 99  
80 +
100 100  {{code language="java"}}
101 101  addCenterParagraph("Текст", 10, true)
102 102  {{/code}}
... ... @@ -107,8 +107,6 @@
107 107  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
108 108  )))
109 109  
110 -* addRightParagraph("текст", размер шрифта, жирный/не жирный)
111 -
112 112  **Пример использования:**
113 113  
114 114  
... ... @@ -122,8 +122,6 @@
122 122  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
123 123  )))
124 124  
125 -* addLeftParagraph("текст", размер шрифта, жирный/не жирный)
126 -
127 127  **Пример использования:**
128 128  
129 129  
... ... @@ -137,8 +137,6 @@
137 137  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
138 138  )))
139 139  
140 -* file.addTextBreak()
141 -
142 142  **Пример использования:**
143 143  
144 144  
... ... @@ -152,8 +152,8 @@
152 152  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
153 153  )))
154 154  
155 -* file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
156 -* file.addText(“Строка, которая появится в файле”)
130 +* с указанием размера текста и указанием жирный/простой
131 +* с опциями (file.addText(“Строка, которая появится в файле”))
157 157  
158 158  **Примеры использования:**
159 159  
... ... @@ -168,11 +168,9 @@
168 168  
169 169  (% class="box infomessage" %)
170 170  (((
171 -**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
146 +**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
172 172  )))
173 173  
174 -* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
175 -
176 176  **Пример использования:**
177 177  
178 178  
... ... @@ -183,11 +183,9 @@
183 183  
184 184  (% class="box infomessage" %)
185 185  (((
186 -**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
159 +**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
187 187  )))
188 188  
189 -* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
190 -
191 191  **Пример использования:**
192 192  
193 193  
... ... @@ -198,63 +198,6 @@
198 198  
199 199  (% class="box infomessage" %)
200 200  (((
201 -**{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
202 -)))
203 -
204 -* file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
205 -
206 -**Пример использования:**
207 -
208 -{{code language="java"}}
209 -file.insertRow(6, "Вставленная строка", 1 , 2.453, new Date(), Calendar.getInstance());
210 -{{/code}}
211 -
212 -
213 -(% class="box infomessage" %)
214 -(((
215 -**{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
216 -)))
217 -
218 -* file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
219 -
220 -**Пример использования:**
221 -
222 -{{code language="java"}}
223 -file.replaceRow(7, "Замещенная строка", 4 , 5.678, new Date(), Calendar.getInstance());
224 -{{/code}}
225 -
226 -
227 -(% class="box infomessage" %)
228 -(((
229 -**{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
230 -)))
231 -
232 -* file.deleteRow(индекс)
233 -
234 -**Пример использования:**
235 -
236 -{{code language="java"}}
237 -file.deleteRow(3);
238 -{{/code}}
239 -
240 -
241 -(% class="box infomessage" %)
242 -(((
243 -**{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
244 -)))
245 -
246 -* file.autoSizeColumns() - для всех колонок на странице
247 -* file.autoSizeColumns(индекс колонки) - для конкретной колонки на странице
248 -
249 -**Пример использования:**
250 -
251 -{{code language="java"}}
252 -file.autoSizeColumns()
253 -{{/code}}
254 -
255 -
256 -(% class="box infomessage" %)
257 -(((
258 258  **{{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/)]]
259 259  )))
260 260  
... ... @@ -292,66 +292,6 @@
292 292  {{/code}}
293 293  
294 294  
295 -(% class="box infomessage" %)
296 -(((
297 -**{{id name="_Toc19"/}}templateToPdf** - генерация пдф документа из шаблона
298 -)))
299 -
300 -* [[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, переменная из плагина)
301 -* file.templateToPdf(template)
302 -
303 -**Пример использования:**
304 -
305 -{{code language="java"}}
306 -def project = bim.getProject()
307 -template.add("project", project)
308 -file.templateToPdf(template)
309 -{{/code}}
310 -
311 -
312 -(% class="box infomessage" %)
313 -(((
314 -**{{id name="_Toc20"/}}collisionsToPdf** - генерация пдф по списку коллизий
315 -)))
316 -
317 -* file.collisionsToPdf(template, list, params):
318 -* template - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
319 -* 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]]
320 -* params - необязательный параметр (описание ниже)
321 -
322 - Параметры при генерации отчета по коллизиям:
323 - pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
324 - fontSize - int значение размера шрифта (в pt)
325 -
326 - **Пример использования:**
327 -
328 -{{code language="java"}}
329 - def param = [:]
330 - param.add("pageSize", 3)
331 - param.add("fontSize", 12)
332 -{{/code}}
333 -
334 - По умолчанию параметры принимают следующие значения:
335 - pageSize - 4
336 - fontSize - 8
337 -
338 -
339 -**Пример использования:**
340 -
341 -{{code language="java"}}
342 -def collisionList = bim.getCollisionsForReport()
343 - def param = [:]
344 - param.add("pageSize", 3)
345 - param.add("fontSize", 12)
346 - file.collisionsToPdf(template, collisionList, param)
347 -{{/code}}
348 -
349 -{{code language="java"}}
350 - def collisionList = bim.getCollisionsForReport()
351 - file.collisionsToPdf(collisionList)
352 -{{/code}}
353 -
354 -
355 355  **Наименование используемых строк row.get:**
356 356  
357 357  
... ... @@ -385,7 +385,6 @@
385 385  (% style="line-height:1.2" %)
386 386  (% 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" %)Единицы измерений
387 387  )))
388 -|(% 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" %)Единица измерения
389 389  |(% 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" %)(((
390 390  (% style="line-height:1.2" %)
391 391  (% 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
... ... @@ -400,7 +400,6 @@
400 400  (% style="line-height:1.2" %)
401 401  (% 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" %)Количество всего
402 402  )))
403 -|(% 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" %)Количество
404 404  |(% 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" %)(((
405 405  (% style="line-height:1.2" %)
406 406  (% 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