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

Last modified by Bimit Administrator on 02.10.2024, 11:55

From 8.1 to 7.1 From 16.4 to 16.3

From version 16.3

edited by Bimit Administrator
on 27.08.2024, 09:55

Change comment: There is no comment for this version

To version 8.1

edited by Bimit Administrator
on 18.02.2022, 13:19

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -11,45 +11,24 @@
  * [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
  * [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
  * [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
--* [[insertRow>>path:#_Toc15]] - функция которая вставляет строку на указанную позицию на странице эксель файла
--* [[replaceRow>>path:#_Toc16]] - функция которая замещает строку на указанной позицию на странице эксель файла
--* [[deleteRow>>path:#_Toc17]] - функция которая удаляет строку с указанной позиции на странице эксель файла
--* [[autoSizeColumns>>path:#_Toc18]] - функция установки автоматической ширины колонок страницы эксель файла
++* insertRow - функция которая вставляет строку на указанную позицию на странице эксель файла
++* replaceRow - функция которая замещает строку на указанной позицию на странице эксель файла
++* deleteRow - функция которая удаляет строку с указанной позиции на странице эксель файла
++* autoSizeColumns - функция установки автоматической ширины колонок страницы эксель файла
  * [[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) документа таблицы эксель
--* [[addAreaBreak>>path:#_Toc30]] - добавление разрыва области PDF документа
--* [[addImage>>path:#_Toc31]] - добавление изображения в документ  Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
--* [[addDrawing>>path:#_Toc32]] - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
--* [[addCell>>path:#_Toc22]] - создание ячейки в указанный столбец
--* [[replaceRow>>path:#_Toc23]] - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
--* [[sortASC>>path:#_Toc24]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
--* [[sortDESC>>path:#_Toc25]] - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
--* [[saveTempTable>>path:#_Toc26]] - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
--* [[xlsxToJSON>>path:#_Toc27]] - преобразование содержимого документа Excel (XLSX, XLS)
--* [[getResource>>path:#_Toc28]] - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
--* [[makeGrandSmetaExelTable>>path:#_Toc29]] - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
--**Генерация документа с использованием шаблона**
--* [[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)
++**{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX)
  )))
--* **file.create(формат создаваемого файла)**
--
  **Пример использования:**
@@ -63,8 +63,8 @@
  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
  )))
--* **file.addTitle(Текст)** - с базовыми настройками
--* **file.addTitle(Текст, Размер шрифта, жирный/не жирный)** - с указанием размера шрифта, и указанием жирный/простой
++* с базовыми настройками
++* с указанием размера шрифта, и указанием жирный/простой
  **Примеры использования:**
@@ -82,8 +82,8 @@
  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
  )))
--* **file.addParagraph("Текст")** - с базовыми настройками
--* **file.addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный)** - с указанием отступа, размера шрифта, и указанием жирный/простой
++* с базовыми настройками
++* с указанием отступа, размера шрифта, и указанием жирный/простой
  **Примеры использования:**
@@ -103,11 +103,10 @@
  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
  )))
--* **file.addCenterParagraph("текст", размер шрифта, жирный/не жирный)**
--
  **Пример использования:**
++
  {{code language="java"}}
  addCenterParagraph("Текст",  10, true)
  {{/code}}
@@ -118,8 +118,6 @@
  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
  )))
--* **file.addRightParagraph("текст", размер шрифта, жирный/не жирный)**
--
  **Пример использования:**
@@ -133,8 +133,6 @@
  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
  )))
--* **file.addLeftParagraph("текст", размер шрифта, жирный/не жирный)**
--
  **Пример использования:**
@@ -148,8 +148,6 @@
  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
  )))
--* **file.addTextBreak()**
--
  **Пример использования:**
@@ -163,17 +163,12 @@
  **{{id name="_Toc8"/}}addText** - функция добавления строки с данным в документ MS Word (DOCX)
  )))
--* **file.addText(Object objectValue)** - добавление объекта в строковом представлении
--* **file.addText(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)**
--* **file.addText(“Строка, которая появится в файле”)**
--* **file.addText(long longValue)** - добавление числа типа long в строковом представлении
--* **file.addText(double doubleValue)** - добавление числа типа double в строковом представлении
++* с указанием размера текста и указанием жирный/простой
++* с опциями (file.addText(“Строка, которая появится в файле”))
  **Примеры использования:**
  {{code language="java"}}
--{{/code}}
--{{code language="java"}}
  file.addText("Строка, которая появится в файле"), 10, false)
  {{/code}}
@@ -181,20 +181,12 @@
  file.addText("Строка, которая появится в файле")
  {{/code}}
--{{code language="java"}}
--{{/code}}
--{{code language="java"}}
--{{/code}}
--
--
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
++**{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла (пример: file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”))
  )))
--* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
--
  **Пример использования:**
@@ -205,11 +205,9 @@
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
++**{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла (пример: file.addRow(“Данные 1”, “Данные 2”,....”Данные N”))
  )))
--* **file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)**
--
  **Пример использования:**
@@ -220,63 +220,6 @@
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
--)))
--
--* **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());
--{{/code}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
--)))
--
--* **file.deleteRow(индекс)**
--
--**Пример использования:**
--
--{{code language="java"}}
--file.deleteRow(3);
--{{/code}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
--)))
--
--* **file.autoSizeColumns()** - для всех колонок на странице
--* **file.autoSizeColumns(индекс колонки)** - для конкретной колонки на странице
--
--**Пример использования:**
--
--{{code language="java"}}
--file.autoSizeColumns()
--{{/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/)]]
  )))
@@ -314,196 +314,6 @@
  {{/code}}
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc19"/}}templateToPdf** - генерация pdf документа из шаблона
--)))
--
--* **[[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** - генерация pdf по списку коллизий
--)))
--
--* **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}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc21"/}}attributesToPdf** - генерация pdf по списку атрибутов
--)))
--
--* **file.attributesToPdf(template, list, params)**
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc30"/}}addAreaBreak** - добавление разрыва области PDF документа
--)))
--
--* **file.addAreaBreak() **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc31"/}}addImage** - добавление изображения в документ  Ms Word(DOCX) или PDF, ести тип файла другой, запись идет в поток
--)))
--
--* **file.addImage(byte[] imageFile) **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc32"/}}addDrawing** - добавление чертежа в документ MS Word (DOCX) или PDF, метод принимает на вход массив байтов, содержащий чертеж и двумерный массив, содержащий координаты точек чертежа
--)))
--
--* **file.addDrawing(byte[] drawingPage, double[][] arr) **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc22"/}}addCell** - создание ячейки в указанный столбец
--)))
--
--* **file.addCell(int indexColumn, int indexRow, Object value) ** - создание ячейки в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
--* **file.addCell(int indexColumn, Object value) ** - создание ячейки в указанный столбец в конец строки текущего листа таблицы Excel (XLSX, XLS) с указанным значением
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc23"/}}replaceRow** - замена значений указанной строки новыми значениями текущего листа таблицыи Excel (XLSX, XLS)
--)))
--
--* **file.replaceRow(int indexRow, Object... inp) **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc24"/}}sortASC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке возрастания по значению в указанном столбце
--)))
--
--* **file.sortASC(int indexColumn) **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc25"/}}sortDESC** - сортировка таблицы документа Excel (XLSX, XLS) в порядке убывания по значению в указанном столбце
--)))
--
--* **file.sortDESC(int indexColumn) **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc26"/}}saveTempTable** - сохранение значений из потока в таблицу Excel (XLSX, XLS), находящейся по указанному пути
--)))
--
--* **file.saveTempTable(String tablesTempLocation) **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc27"/}}xlsxToJSON** - преобразование содержимого документа Excel (XLSX, XLS)
--)))
--
--* **file.xlsxToJSON(int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS) с указанной страницы, с указанным количеством строк в формат JSON
--* **file.xlsxToJSON(String tablesTempLocation, int page, int pageSize) ** - преобразование содержимого документа Excel (XLSX, XLS), находящегося по указанному пути в формате JSON, с учетом указанной страницы и указанных количество строк
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc28"/}}getResource** - метод возвращает объект Ms Word (DOCX), PDF, текстовый файл (TXT) или Excel (XLSX, XLS)
--)))
--
--* **file.getResource() **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc29"/}}makeGrandSmetaExelTable** - создание документа Excel (XLSX, XLS) для отчета о гранд-смете
--)))
--
--* **file.makeGrandSmetaExelTable() **
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
  **Наименование используемых строк row.get:**