docs/excel-export.yaml - master - anbu/plugin_example_excel

docs/excel-export.yaml
175 строк8 KB
Aleksandr
first_commit
27 дек 2024, 13:32
27 дек 2024, 13:32415398d
### ***********  ПРИМЕР ОПИСАНИЯ СТИЛЕЙ НА ЛЮБОМ УРОВНЕ ***********
#  style:
#    alignment:               # Расположение текста
#      horizontal: center       # left | center | right | fill | justify | centerContinuous | distributed
#      vertical: middle         # top | middle | bottom | distributed | justify
#    font:                    # Стили текста
#      size: 24                 # Размер
#      color: D145BE            # Цвет
#      name: Arial Black        # Шрифт
#      bold: true               # Флаг применения стиля   false | true
#      italic: true             # Флаг применения стиля   false | true
#      underline: single        # Флаг применения стиля   false | true
#      strike: true             # Флаг применения стиля   false | true
#    background: 279144       # Цвет фона
#    border:                  # Стили границ
#      style: hair              # thin | dotted | hair | medium | double | thick | dashed | dashDot | dashDotDot | slantDashDot | mediumDashed | mediumDashDotDot | mediumDashDot
#      color: B80000            # Цвет


docs:
  excel-export-template:
    type: excel-export
    location: Описание / Экспорт

    options:                                      # Глобальные опции для компонентов и документа
      show-grid-lines: false                      # ? Отражение сетки true/false
      margin-left: 3.5                            # ? Добавляет пустую колонку слева шириной 3.5
      margin-top: 10.5                            # ? Добавляет пустую строку сверху высотой 10.5
      table:
        headers:                                  # Глобальная стилизация заголовокв
          height: 28.5                            # ? Высота строки заголовка

    templates:                                    # Переиспользуемые шаблоны, могут быть использованы в компонентах (пока поддерживается только type:rows)
      template_1:
        type: rows
        title: КОМПОНЕНТ ИЗ ШАБЛОНА
        rows:
          - ROW 1
          - ROW 2
          - - value: 1
              style:
                font:
                  style: italic
                border:
                  style: dotted
            - value: 2
              style:
                font:
                  style: italic
                border:
                  style: dotted
            - style:
                background: d145be

    pages:                                      # Страницы
      - name: Страница 1                        # Используется для имени вкладки
        link:                                   # Ссылка на страницу
          text: Текст Ссылки
          path: Страница 1
        title: Заголовок 1 уровня               # ?
        subtitle: Заголовок 2 уровня            # ?
        description: Описание страницы          # ?

      - name: Страница 2                        # !
        link:                                   # Ссылка на страницу
          text: ссылка СТРАНИЦЫ
          path: Страница 1
        title: Заголовок 1 СТРАНИЦЫ             # ?
        subtitle: Заголовок 2 СТРАНИЦЫ          # ?
        description: Описание СТРАНИЦЫ          # ?

        components:                             # Компоненты на странице (table, rows)

          - type: table                         # ! Основной компонент с данными
            name: firstTable                    # ! Уникальное имя (camelCaseNotation)

            title: Заголовок 1 КОМПОНЕНТА       # ?
            subtitle: Заголовок 2 КОМПОНЕНТА    # ?
            description: Описание КОМПОНЕНТА    # ?

            headers:                            # ! заголовки для компонента table
              - value: Колонка 1                # !
                type: text                      # ? text (default) / select / link
                style:                          # ?
                  alignment:
                    horizontal: center
                    vertical: middle
                  font:
                    size: 24
                    color: D145BE
                    name: Arial Black
                    bold: true
                    italic: true
                    underline: single
                    strike: true
                  background: 279144
                  border:
                    style: double
                    color: B80000

              - value: Колонка 2
                style:
                  font:
                    size: 24
                  border:
                    color: B80000
              - value: Колонка 3
                type: select
                options:
                  - Селектор 1
                  - Селектор 2
                  - Селектор 3
              - value: Колонка 4
                type: link  # ссылка указывается на страницу, путем указания ее имени
            source: >
              (
                  {  
                      "body": [
                        ["R1 C1", "R1 C2", "", "Страница 1"],
                        ["R2 C1", "R2 C2", "Селектор 1", "Страница 1"],
                        ["R3 C1", "R3 C2", "", "Страница 1"],
                        ["R4 C1", "R4 C2", "", "Страница 1"]
                      ]
                  };
              )
              
              
          - type: rows
            title: Заголовок компонента СТРОКИ
            description: Описание компонента СТРОКИ
            rows:
              - может быть просто строкой                           # вставка элеменгта в строку
              - - или массивом для вставки в ячеки строки           # вставка элемента в ячейку
                - ячейка 2
                - ячейка 3
              - 3 строка
              - - value: или объектом
                - value: 20
                  style:
                    font:
                      style: italic
                    border:
                      style: dotted
                - style:                # или просто стилем для ячейки
                    background: d145be  # HEX

          - type: template
            name: template_1

          - type: table                         # ! Основной компонент с данными
            name: tableForImport                # ! Уникальное имя (camelCaseNotation)
            subtitle: Параметризуемая таблица   # ?
            headers:                            # ! Заголовки для компонента table
              - value: Колонка 1                # !
              - value: Колонка 2                # !

            source: >
              (   
                  $headers := [
                      {"value": "Col 1"},
                      {"value": "Col 2"},
                      {"value": "Col 3", "style": {"background": "FFFF00"}}
                  ];
                  {   
                      "headers": $headers,
                      "body": [
                        ["R1 C1", "R1 C2", 123],
                        ["R2 C1", "R2 C2", 123],
                        ["R3 C1", "R3 C2", 123],
                        ["R4 C1", "R4 C2", 123]
                      ]
                  }
              )
              
#               При указании headers в запросе - будут использованы заголовки из source