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

Last modified by Bimit Administrator on 02.10.2024, 11:55

From 4.1 to 3.1 From 11.1 to 10.7

From version 10.7

edited by Bimit Administrator
on 18.07.2023, 10:11

Change comment: There is no comment for this version

To version 4.1

edited by Bimit Administrator
on 15.02.2022, 09:50

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,44 +1,31 @@
  Это интерфейс создания и заполнения файлов отчет/смет
  В нем доступны следующий функции:
--* [[create>>path:#_Toc1]] - функция конструктор, создает и подготавливает файл для приема данных
--* [[addTitle>>path:#_Toc2]] - добавление заголовка в документ MS Word (DOCX)
--* [[addParagraph>>path:#_Toc3]] - функция создания нового параграфа в документе MS Word (DOCX)
--* [[addCenterParagraph>>path:#_Toc4]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
--* [[addRightParagraph>>path:#_Toc5]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
--* [[addLeftParagraph>>path:#_Toc6]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
--* [[addTextBreak>>path:#_Toc7]] - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
--* [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
--* [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
--* [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
--* [[insertRow>>path:#_Toc15]] - функция которая вставляет строку на указанную позицию на странице эксель файла
--* [[replaceRow>>path:#_Toc16]] - функция которая замещает строку на указанной позицию на странице эксель файла
--* [[deleteRow>>path:#_Toc17]] - функция которая удаляет строку с указанной позиции на странице эксель файла
--* [[autoSizeColumns>>path:#_Toc18]] - функция установки автоматической ширины колонок страницы эксель файла
--* [[getDocument>>path:#_Toc11]] - получение интерфейса текущего документа XWPFDocument (docx) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFDocument.html), предоставляет полный доступ к инструментарию формирования документа MSWord
--* [[getParagraph>>path:#_Toc12]] - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord
--* [[getWorkbook>>path:#_Toc13]] - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель
--* [[getSheet>>path:#_Toc14]] - получение интерфейса текущей страницы с таблицей (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Sheet.html) документа таблицы эксель
++* [[create>>||anchor="Hcreate"]] - функция конструктор, создает и подготавливает файл для приема данных
++* [[addTitle>>||anchor="HaddTitle"]] - добавление заголовка в документ MS Word (DOCX) c базовыми настройками
++* [[addTitle>>||anchor="HaddTitle"]] - добавление заголовка в документ MS Word (DOCX), с указанием размера шрифта, и указанием жирный/простой
++* [[addParagraph>>||anchor="HaddParagraph"]] - функция создания нового параграфа в документе MS Word (DOCX) с базовыми настройками
++* [[addParagraph>>||anchor="HaddParagraph"]] - функция создания нового параграфа в документе MS Word (DOCX) с указанием отступа, размера шрифта, и указанием жирный/простой
++* [[addCenterParagraph>>||anchor="HaddCenterParagraph"]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
++* [[addRightParagraph>>||anchor="HaddRightParagraph"]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
++* [[addLeftParagraph>>||anchor="HaddLeftParagraph"]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
++* [[addTextBreak>>||anchor="HaddTextBreak"]] - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
++* [[addText>>||anchor="HaddText"]] - функция добавления строки с данным в документ MS Word (DOCX) с указанием размера текста и указанием жирный/простой
++* [[addText>>||anchor="HaddText"]] - функция добавления строки с данным в текстовый файл с опциями (file.addText(“Строка, которая появится в файле”))
++* [[addHeaderRow>>||anchor="HaddHeaderRow"]] - функция которая формирует заголовок на странице эксель файла
++* [[addRow>>||anchor="HaddRow"]] - функция которая формирует строку на странице эксель файла
++* [[getDocument>>||anchor="HgetDocument"]] - получение интерфейса текущего документа XWPFDocument (docx) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFDocument.html), предоставляет полный доступ к инструментарию формирования документа MSWord
++* [[getParagraph>>||anchor="HgetParagraph"]] - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord
++* [[getWorkbook>>||anchor="HgetWorkbook"]] - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель
++* [[getSheet>>||anchor="HgetSheet"]] - получение интерфейса текущей страницы с таблицей (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Sheet.html) документа таблицы эксель
--**Генерация документа с использованием шаблона**
--* [[templateToPdf>>path:#_Toc19]] - генерация pdf документа из шаблона
--**Генерация отчета по коллизиям и атрибутам**
--
--* [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
--* [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
--
--[[Примеры использования в плагинах>>Примеры использования в плагинах]]
--
--
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
++**create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
  )))
--* file.create(формат создаваемого файла)
--
  **Пример использования:**
@@ -49,228 +49,180 @@
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
++**addTitle** - добавление заголовка в документ MS Word (DOCX) c базовыми настройками
  )))
--* file.addTitle(Текст) - с базовыми настройками
--* file.addTitle(Текст, Размер шрифта, жирный/не жирный) - с указанием размера шрифта, и указанием жирный/простой
++**Пример использования:**
--**Примеры использования:**
  {{code language="java"}}
  addTitle("Заголовок")
  {{/code}}
--{{code language="java"}}
--addTitle("Заголовок",  30, true)
--{{/code}}
--
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
++**addTitle** - добавление заголовка в документ MS Word (DOCX), с указанием размера шрифта, и указанием жирный/простой
  )))
--* addParagraph("Текст") - с базовыми настройками
--* addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный) - с указанием отступа, размера шрифта, и указанием жирный/простой
++**Пример использования:**
--**Примеры использования:**
  {{code language="java"}}
--addParagraph("Текст")
--addText("Продолжение текста")
++addTitle("Заголовок",  30, true)
  {{/code}}
--{{code language="java"}}
--addParagraph("Текст", 20, 10, true)
--addText("Продолжение текста")
--{{/code}}
--
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
++**addParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с базовыми настройками
  )))
--* addCenterParagraph("текст", размер шрифта, жирный/не жирный)
--
  **Пример использования:**
  {{code language="java"}}
--addCenterParagraph("Текст",  10, true)
++addParagraph("Текст")
++addText("Продолжение текста")
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
++**addParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с указанием отступа, размера шрифта, и указанием жирный/простой
  )))
--* addRightParagraph("текст", размер шрифта, жирный/не жирный)
--
  **Пример использования:**
  {{code language="java"}}
--addRightParagraph("Текст",  10, true)
++addParagraph("Текст", 20, 10, true)
++addText("Продолжение текста")
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
++**addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
  )))
--* addLeftParagraph("текст", размер шрифта, жирный/не жирный)
--
  **Пример использования:**
  {{code language="java"}}
--addLeftParagraph("Текст",  10, true)
++addCenterParagraph("Текст",  10, true)
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
++**addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
  )))
--* file.addTextBreak()
--
  **Пример использования:**
  {{code language="java"}}
--file.addTextBreak()
++addRightParagraph("Текст",  10, true)
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
++**addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
  )))
--* file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
--* file.addText(“Строка, которая появится в файле”)
++**Пример использования:**
--**Примеры использования:**
  {{code language="java"}}
--file.addText("Строка, которая появится в файле"), 10, false)
++addLeftParagraph("Текст",  10, true)
  {{/code}}
--{{code language="java"}}
--file.addText("Строка, которая появится в файле")
--{{/code}}
--
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
++**addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
  )))
--* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
--
  **Пример использования:**
  {{code language="java"}}
--file.addHeaderRow("Код", "Название", "Ед. изм.", "Кол. во.");
++file.addTextBreak()
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
++**addText** - функция добавления строки с данным в документ MS Word (DOCX) с указанием размера текста и указанием жирный/простой
  )))
--* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
--
  **Пример использования:**
  {{code language="java"}}
--file.addRow( row.get("code"), row.get("title"), row.get("units"), row.get("quantityAll"));
++file.addText("Строка, которая появится в файле"), 10, false)
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
++**addText** - функция добавления строки с данным в текстовый файл с опциями (file.addText(“Строка, которая появится в файле”))
  )))
--* file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
--
  **Пример использования:**
--{{code language="java"}}
--file.insertRow(6, "Вставленная строка", 1 , 2.453, new Date(), Calendar.getInstance());
--{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
--)))
--
--* file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
--
--**Пример использования:**
--
  {{code language="java"}}
--file.replaceRow(7, "Замещенная строка", 4 , 5.678, new Date(), Calendar.getInstance());
++file.addText("Строка, которая появится в файле")
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
++**addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
  )))
--* file.deleteRow(индекс)
--
  **Пример использования:**
++
  {{code language="java"}}
--file.deleteRow(3);
++file.addHeaderRow("Код", "Название", "Ед. изм.", "Кол. во.");
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
++**addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
  )))
--* file.autoSizeColumns() - для всех колонок на странице
--* file.autoSizeColumns(индекс колонки) - для конкретной колонки на странице
--
  **Пример использования:**
++
  {{code language="java"}}
--file.autoSizeColumns()
++file.addRow( row.get("code"), row.get("title"), row.get("units"), row.get("quantityAll"));
  {{/code}}
  (% class="box infomessage" %)
  (((
--**{{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/)]]
++**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/)]]
  )))
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc12"/}}getParagraph** - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord  (полную документацию см. [[https:~~/~~/poi.apache.org/apidocs/4.1/)>>https://poi.apache.org/apidocs/4.1/)]]
++**getParagraph** - получение интерфейса текущего параграфа XWPFParagraph (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/xwpf/usermodel/XWPFParagraph.html) документа MSWord  (полную документацию см. [[https:~~/~~/poi.apache.org/apidocs/4.1/)>>https://poi.apache.org/apidocs/4.1/)]]
  )))
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc13"/}}getWorkbook** - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель (полную документацию см. https:~/~/poi.apache.org/apidocs/4.1/)
++**getWorkbook** - получение интерфейса текущего табличного документа Workbook (XSSFWorkbook для xlsx и HSSFWorkbook для xls) (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Workbook.html), предоставляет полный доступ к инструментарию формирования документа таблицы эксель (полную документацию см. https:~/~/poi.apache.org/apidocs/4.1/)
  )))
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc14"/}}getSheet** - получение интерфейса текущей страницы с таблицей (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Sheet.html) документа таблицы эксель (полную документацию см. https:~/~/poi.apache.org/apidocs/4.1/)
++**getSheet** - получение интерфейса текущей страницы с таблицей (https:~/~/poi.apache.org/apidocs/4.1/org/apache/poi/ss/usermodel/Sheet.html) документа таблицы эксель (полную документацию см. https:~/~/poi.apache.org/apidocs/4.1/)
  )))
  **Общий пример:**
@@ -292,66 +292,6 @@
  {{/code}}
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc19"/}}templateToPdf** - генерация пдф документа из шаблона
--)))
--
--* [[template>>doc:API.Плагин API.template.WebHome]].add(“название тега в шаблоне”, переменная из плагина)
--* file.templateToPdf(template)
--
--**Пример использования:**
--
--{{code language="java"}}
--def project = bim.getProject()
--template.add("project", project)
--file.templateToPdf(template)
--{{/code}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc20"/}}collisionsToPdf** - генерация пдф по списку коллизий
--)))
--
--* file.collisionsToPdf(template, list, params):
--* template - необязательный параметр (указывается в том случае, если таблицу коллизий необходимо добавить в конец какого-либо шаблона). Если не указывать, то создается новый пустой файл, в который заносится таблица коллизий
--* 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]]
--* params - необязательный параметр (описание ниже)
--
--            Параметры при генерации отчета по коллизиям:
--            pageSize - 1, 2, 3 или 4 (соответствует размеру страницы А1, А2, А3, А4)
--            fontSize - int значение размера шрифта (в pt)
--
--            **Пример использования:**
--
--{{code language="java"}}
-- def param = [:]
-- param.add("pageSize", 3)
-- param.add("fontSize", 12)
--{{/code}}
--
--            По умолчанию параметры принимают следующие значения:
--            pageSize - 4
--            fontSize - 8
--
--
--**Пример использования:**
--
--{{code language="java"}}
--def collisionList = bim.getCollisionsForReport()
-- def param = [:]
-- param.add("pageSize", 3)
-- param.add("fontSize", 12)
-- file.collisionsToPdf(template, collisionList, param)
--{{/code}}
--
--{{code language="java"}}
-- def collisionList = bim.getCollisionsForReport()
-- file.collisionsToPdf(collisionList)
--{{/code}}
--
--
  **Наименование используемых строк row.get:**
@@ -385,7 +385,6 @@
  (% style="line-height:1.2" %)
  (% 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" %)Единицы измерений
  )))
--|(% 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" %)Единица измерения
  |(% 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" %)(((
  (% style="line-height:1.2" %)
  (% 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 @@
  (% style="line-height:1.2" %)
  (% 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" %)Количество всего
  )))
--|(% 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" %)Количество
  |(% 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" %)(((
  (% style="line-height:1.2" %)
  (% 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