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

Last modified by Bimit Administrator on 02.10.2024, 11:55

From 10.5 to 10.4 From 17.8 to 17.7

From version 17.7

edited by Bimit Administrator
on 02.10.2024, 11:48

Change comment: There is no comment for this version

To version 10.5

edited by Bimit Administrator
on 18.07.2023, 09:57

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -2,7 +2,6 @@
  В нем доступны следующий функции:
  * [[create>>path:#_Toc1]] - функция конструктор, создает и подготавливает файл для приема данных
--* [[setStyle>>path:#_Toc33]] - применение указанного стиля к тексту указанной ячейки Excel файла при работе с отчетом
  * [[addTitle>>path:#_Toc2]] - добавление заголовка в документ MS Word (DOCX)
  * [[addParagraph>>path:#_Toc3]] - функция создания нового параграфа в документе MS Word (DOCX)
  * [[addCenterParagraph>>path:#_Toc4]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
@@ -10,16 +10,10 @@
  * [[addLeftParagraph>>path:#_Toc6]] - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
  * [[addTextBreak>>path:#_Toc7]] - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
  * [[addText>>path:#_Toc8]] - функция добавления строки с данным в документ MS Word (DOCX)
--* (% style="color:#000000; font-family:Arial,sans-serif; font-size:11pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)[[createStyle>>path:#_Toc30]] - cоздание нового стиля для форматирования текста и формата ячеек Excel при работе с отчетом
--* [[setSizeColumns>>path:#_Toc34]] - устанавливает ширину и высоту для ячеек заданной колонки
--* [[setCenterAlignment>>path:#_Toc35]] - устанавливает выравнивание по центру для всех ячеек заданной колонки
--* [[setBorder>>path:#_Toc36]] - устанавливает границы для указанного диапазона ячеек
--* [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице Excel файла
++* [[addHeaderRow>>path:#_Toc9]] - функция которая формирует заголовок на странице эксель файла
  * [[addRow>>path:#_Toc10]] - функция которая формирует строку на странице эксель файла
  * [[insertRow>>path:#_Toc15]] - функция которая вставляет строку на указанную позицию на странице эксель файла
  * [[replaceRow>>path:#_Toc16]] - функция которая замещает строку на указанной позицию на странице эксель файла
--* [[addMatrix>>path:#_Toc37]] - создание таблицы Excel (XLSX, XLS) с данными из List
--* [[addCellWrap>>path:#_Toc38]] - создание ячейки с переносом текста в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
  * [[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
@@ -26,17 +26,6 @@
  * [[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) для отчета о гранд-смете
  **Генерация документа с использованием шаблона**
@@ -47,6 +47,7 @@
  * [[collisionsToPdf>>path:#_Toc20]] - генерация pdf по списку коллизий
  * [[attributesToPdf>>path:#_Toc21]] - генерация pdf по списку атрибутов
++
  [[Примеры использования в плагинах>>Примеры использования в плагинах]]
@@ -55,7 +55,7 @@
  **{{id name="_Toc1"/}}create** - функция конструктор, создает и подготавливает файл для приема данных, доступны варианта: таблица эксель (XLS, XLSX), текстовый файл(TXT), документ MS Word (DOCX), документ PDF (PDF)
  )))
--* **file.create(формат создаваемого файла)**
++* file.create(формат создаваемого файла)
  **Пример использования:**
@@ -67,24 +67,11 @@
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc33"/}}setStyle** - применение указанного стиля к тексту указанной ячейки Excel файла при работе с отчетом
--)))
--
--* **file.setStyle (Sheet sheet, Workbook workbook, int indexRow, int indexColumn, ExcelStyleManager)**
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--* **file.setStyle (Sheet sheet, Workbook workbook, int indexRow, int indexColumn, ExcelStyleManager)**
--
--(% class="box infomessage" %)
--(((
  **{{id name="_Toc2"/}}addTitle** - добавление заголовка в документ MS Word (DOCX)
  )))
--* **file.addTitle(Текст)** - с базовыми настройками
--* **file.addTitle(Текст, Размер шрифта, жирный/не жирный)** - с указанием размера шрифта, и указанием жирный/простой
++* file.addTitle(Текст) - с базовыми настройками
++* file.addTitle(Текст, Размер шрифта, жирный/не жирный) - с указанием размера шрифта, и указанием жирный/простой
  **Примеры использования:**
@@ -96,13 +96,14 @@
  addTitle("Заголовок",  30, true)
  {{/code}}
++
  (% class="box infomessage" %)
  (((
  **{{id name="_Toc3"/}}addParagraph** - функция создания нового параграфа в документе MS Word (DOCX)
  )))
--* **file.addParagraph("Текст")** - с базовыми настройками
--* **file.addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный)** - с указанием отступа, размера шрифта, и указанием жирный/простой
++* addParagraph("Текст") - с базовыми настройками
++* addParagraph("Текст", размер отступа, размер шрифта, жирный/не жирный) - с указанием отступа, размера шрифта, и указанием жирный/простой
  **Примеры использования:**
@@ -122,7 +122,7 @@
  **{{id name="_Toc4"/}}addCenterParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста посередине и с указанием размера шрифта, и указанием жирный/простой
  )))
--* **file.addCenterParagraph("текст", размер шрифта, жирный/не жирный)**
++* addCenterParagraph("текст", размер шрифта, жирный/не жирный)
  **Пример использования:**
@@ -131,18 +131,13 @@
  addCenterParagraph("Текст",  10, true)
  {{/code}}
--(% class="box infomessage" %)
--(((
--(% id="cke_bm_264586S" style="display:none" %)** **
--)))
--
  (% class="box infomessage" %)
  (((
  **{{id name="_Toc5"/}}addRightParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста справа и с указанием размера шрифта, и указанием жирный/простой
  )))
--* **file.addRightParagraph("текст", размер шрифта, жирный/не жирный)**
++* addRightParagraph("текст", размер шрифта, жирный/не жирный)
  **Пример использования:**
@@ -157,7 +157,7 @@
  **{{id name="_Toc6"/}}addLeftParagraph** - функция создания нового параграфа в документе MS Word (DOCX) с размещением текста слева и с указанием размера шрифта, и указанием жирный/простой
  )))
--* **file.addLeftParagraph("текст", размер шрифта, жирный/не жирный)**
++* addLeftParagraph("текст", размер шрифта, жирный/не жирный)
  **Пример использования:**
@@ -172,7 +172,7 @@
  **{{id name="_Toc7"/}}addTextBreak** - функция перевода каретки указателя на новую строку в документе MS Word (DOCX)
  )))
--* **file.addTextBreak()**
++* file.addTextBreak()
  **Пример использования:**
@@ -187,71 +187,26 @@
  **{{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(“Строка, которая появится в файле”, размер шрифта, жирный/не жирный)
++* file.addText(“Строка, которая появится в файле”)
  **Примеры использования:**
--{{code language="java"}}{{/code}}
--{{code language="java"}}file.addText("Строка, которая появится в файле"), 10, false){{/code}}
++{{code language="java"}}
++file.addText("Строка, которая появится в файле"), 10, false)
++{{/code}}
  {{code language="java"}}
  file.addText("Строка, которая появится в файле")
  {{/code}}
--{{code language="java"}}{{/code}}
--{{code language="java"}}{{/code}}
--
--
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc34"/}}setSizeColumns** - устанавливает ширину и высоту для ячеек заданной колонки
--)))
--
--* **file.setSizeColumns (int indexColumn, int indexRowStart, int width, int height)** - устанавливает ширину и высоту для ячеек заданной колонки
--* **file.setSizeColumns (int indexColumn, int width)** - устанавливает ширину для ячеек заданной колонки
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--{{code language="java"}}{{/code}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc35"/}}setCenterAlignment** - устанавливает выравнивание по центру для всех ячеек заданной колонки
--)))
--
--* **file.setCenterAlignment (int indexColumn)** - устанавливает выравнивание по центру для всех ячеек заданной колонки
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc36"/}}setBorder** - устанавливает границы для указанного диапазона ячеек
--)))
--
--* **file.setBorder (int startColumn, int endColumn, int startRow, int endRow)** - устанавливает границы для указанного диапазона ячеек
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--
--(% class="box infomessage" %)
--(((
  **{{id name="_Toc9"/}}addHeaderRow **- функция которая формирует заголовок на странице эксель файла
  )))
--* **file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)**
++* file.addHeaderRow(“Заголовок 1”, “Заголовок 2”,....”Заголовок N”)
  **Пример использования:**
@@ -266,8 +266,7 @@
  **{{id name="_Toc10"/}}addRow** - функция которая формирует строку на странице эксель файла
  )))
--* **file.addRow(Object... inp)**
--* **file.addRow(Map<Object, Object>... inp)**
++* file.addRow(“Данные 1”, “Данные 2”,....”Данные N”)
  **Пример использования:**
@@ -276,15 +276,13 @@
  file.addRow( row.get("code"), row.get("title"), row.get("units"), row.get("quantityAll"));
  {{/code}}
--{{code language="java"}}{{/code}}
--
  (% class="box infomessage" %)
  (((
  **{{id name="_Toc15"/}}insertRow** - функция которая вставляет строку на указанную позицию на странице эксель файла
  )))
--* **file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
++* file.insertRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
  **Пример использования:**
@@ -298,7 +298,7 @@
  **{{id name="_Toc16"/}}replaceRow** - функция которая замещает строку на указанной позицию на странице эксель файла
  )))
--* **file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)**
++* file.replaceRow(индекс, “Данные 1”, “Данные 2”,....”Данные N”)
  **Пример использования:**
@@ -309,37 +309,10 @@
  (% class="box infomessage" %)
  (((
--**{{id name="_Toc37"/}}addMatrix** - создание таблицы Excel (XLSX, XLS) с данными из List
--)))
--
--* **file.addMatrix (List... matrix)** - создание таблицы Excel (XLSX, XLS) с данными из List<List>
--* **file.addMatrix (Map... matrix)** - создание таблицы Excel (XLSX, XLS) с данными из List<Map>
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--{{code language="java"}}{{/code}}
--
--
--(% class="box infomessage" %)
--(((
--**{{id name="_Toc38"/}}addCellWrap** - создание ячейки с переносом текста в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
--)))
--
--* **file.addCellWrap (int indexColumn, int indexRow, Object value)** - создание ячейки с переносом текста в указанный столбец и строку текущего листа таблицы Excel (XLSX, XLS) с указанным значением
--
--**Пример использования:**
--
--{{code language="java"}}{{/code}}
--
--
--(% class="box infomessage" %)
--(((
  **{{id name="_Toc17"/}}deleteRow** - функция которая удаляет строку с указанной позиции на странице эксель файла
  )))
--* **file.deleteRow(индекс)**
++* file.deleteRow(индекс)
  **Пример использования:**
@@ -353,8 +353,8 @@
  **{{id name="_Toc18"/}}autoSizeColumns** - функция установки автоматической ширины колонок страницы эксель файла
  )))
--* **file.autoSizeColumns()** - для всех колонок на странице
--* **file.autoSizeColumns(индекс колонки)** - для конкретной колонки на странице
++* file.autoSizeColumns() - для всех колонок на странице
++* file.autoSizeColumns(индекс колонки) - для конкретной колонки на странице
  **Пример использования:**
@@ -402,210 +402,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}}
--
--(% class="box infomessage" %)
--(((
--(% id="cke_bm_467759S" style="display:none" %)** **(%%)**{{id name="_Toc3"/}}**createStyle - создание нового стиля для формирования текста и формата ячеек Excel при работе с отчетом
--)))
--
--* **file.createStyle(Шрифт строки, размер строки, цвет строки)**
--
--**Пример использования:**
--
--
--{{code language="java"}}
--createStyle(10, 15, green)
--{{/code}}
--
  **Наименование используемых строк row.get:**