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

Last modified by Bimit Administrator on 02.10.2024, 11:55
From version 8.1
edited by Bimit Administrator
on 18.02.2022, 13:19
Change comment: There is no comment for this version
To version 13.1
edited by Bimit Administrator
on 18.07.2023, 10:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -11,24 +11,34 @@
11 11  * [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
12 12  * [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
13 13  * [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
14 -* insertRow - функция которая вставляет строку на указанную позицию на странице эксель файла
15 -* replaceRow - функция которая замещает строку на указанной позицию на странице эксель файла
16 -* deleteRow - функция которая удаляет строку с указанной позиции на странице эксель файла
17 -* autoSizeColumns - функция установки автоматической ширины колонок страницы эксель файла
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 +**Генерация документа с использованием шаблона**
23 23  
25 +* [[templateToPdf>>path:#_Toc19]] - генерация pdf документа из шаблона
26 +
27 +**Генерация отчета по коллизиям и атрибутам**
28 +
29 +* [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
30 +* [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
31 +
24 24  [[Примеры использования в плагинах>>Примеры использования в плагинах]]
25 25  
26 26  
27 27  (% class="box infomessage" %)
28 28  (((
29 -**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
37 +**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
30 30  )))
31 31  
40 +* file.create(формат создаваемого файла)
41 +
32 32  **Пример использования:**
33 33  
34 34  
... ... @@ -42,8 +42,8 @@
42 42  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
43 43  )))
44 44  
45 -* с базовыми настройками
46 -* с указанием размера шрифта, и указанием жирный/простой
55 +* file.addTitle(Текст) - с базовыми настройками
56 +* file.addTitle(Текст, Размер шрифта, жирный/не жирный) - с указанием размера шрифта, и указанием жирный/простой
47 47  
48 48  **Примеры использования:**
49 49  
... ... @@ -61,8 +61,8 @@
61 61  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
62 62  )))
63 63  
64 -* с базовыми настройками
65 -* с указанием отступа, размера шрифта, и указанием жирный/простой
74 +* addParagraph("Текст") - с базовыми настройками
75 +* addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный) - с указанием отступа, размера шрифта, и указанием жирный/простой
66 66  
67 67  **Примеры использования:**
68 68  
... ... @@ -82,10 +82,11 @@
82 82  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
83 83  )))
84 84  
95 +* addCenterParagraph("текст", размер шрифта, жирный/не жирный)
96 +
85 85  **Пример использования:**
86 86  
87 87  
88 -
89 89  {{code language="java"}}
90 90  addCenterParagraph("Текст", 10, true)
91 91  {{/code}}
... ... @@ -96,6 +96,8 @@
96 96  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
97 97  )))
98 98  
110 +* addRightParagraph("текст", размер шрифта, жирный/не жирный)
111 +
99 99  **Пример использования:**
100 100  
101 101  
... ... @@ -109,6 +109,8 @@
109 109  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
110 110  )))
111 111  
125 +* addLeftParagraph("текст", размер шрифта, жирный/не жирный)
126 +
112 112  **Пример использования:**
113 113  
114 114  
... ... @@ -122,6 +122,8 @@
122 122  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
123 123  )))
124 124  
140 +* file.addTextBreak()
141 +
125 125  **Пример использования:**
126 126  
127 127  
... ... @@ -135,8 +135,8 @@
135 135  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
136 136  )))
137 137  
138 -* с указанием размера текста и указанием жирный/простой
139 -* с опциями (file.addText(“Строка, которая появится в файле”))
155 +* file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
156 +* file.addText(“Строка, которая появится в файле”)
140 140  
141 141  **Примеры использования:**
142 142  
... ... @@ -151,9 +151,11 @@
151 151  
152 152  (% class="box infomessage" %)
153 153  (((
154 -**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
171 +**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
155 155  )))
156 156  
174 +* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
175 +
157 157  **Пример использования:**
158 158  
159 159  
... ... @@ -164,9 +164,11 @@
164 164  
165 165  (% class="box infomessage" %)
166 166  (((
167 -**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
186 +**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
168 168  )))
169 169  
189 +* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
190 +
170 170  **Пример использования:**
171 171  
172 172  
... ... @@ -177,6 +177,63 @@
177 177  
178 178  (% class="box infomessage" %)
179 179  (((
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 +(((
180 180  **{{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/)]]
181 181  )))
182 182  
... ... @@ -214,6 +214,75 @@
214 214  {{/code}}
215 215  
216 216  
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 +(% class="box infomessage" %)
356 +(((
357 +**{{id name="_Toc21"/}}attributesToPdf** - генерация пдф по списку атрибутов
358 +)))
359 +
360 +* file.attributesToPdf(template, list, params)
361 +
362 +
363 +
217 217  **Наименование используемых строк row.get:**
218 218  
219 219