Параметры для подписанных встраиваний¶

Другое название - автономное встраивание.

Параметры — это данные, которые передаются между GlarusBI и вашим веб-сайтом через URL-адрес встраивания. Вы можете использовать параметры, чтобы указать, как элементы GlarusBI должны выглядеть и вести себя внутри iframe на вашем веб-сайте.

Параметры добавляются в конец URL-адреса для встраивания, например:

your_embedding_url?parameter_name=value

Добавление виджета фильтра в подписанную вставку¶

Вы можете использовать редактируемые параметры, чтобы добавить виджеты фильтров во встроенные информационные панели или вопросы SQL.

Перейдите на панель управления или на вопрос SQL. Убедитесь, что вы настроили фильтр дашборда или переменную SQL.
Нажмите на значок общего доступа > Встроить этот элемент в приложение.
В разделе Параметры вы найдете имена фильтров вашего дашборда или переменных SQL.
Выберите Редактируемый для каждого параметра, который должен получить виджет фильтра во встраивании.
Нажмите Опубликовать, чтобы сохранить изменения.
Добавьте или обновите код на своем сервере, чтобы он соответствовал коду, сгенерированному GlarusBI.

Редактируемые параметры отвечают за передачу значений фильтра из встроенного виджета фильтра (отображаемого в iframe).

Обратите внимание, что заблокированные параметры могут ограничивать значения, отображаемые во встроенном виджете фильтра.

Заполнение виджета встроенного фильтра значением по умолчанию¶

Если вы хотите установить значение по умолчанию для вашего встроенного виджета фильтра, вы можете передать его в соответствующее имя параметра в URL-адресе внедрения. Обратите внимание, что:

Параметр names в нижнем регистре.
Параметр values чувствителен к регистру (они должны совпадать с вашими данными).
Пробелы должны быть заменены символами подчеркивания.

Например, если на встроенной информационной панели есть фильтр «Завтрак», и вы хотите установить значение по умолчанию «Яичница-болтунья»:

your_embedding_url?breakfast=Scrambled_eggs

Чтобы указать значения по умолчанию для нескольких фильтров, разделите фильтры амперсандами (&):

your_embedding_url?breakfast=Scrambled_eggs&lunch=Grilled_cheese

Вы можете установить несколько значений по умолчанию для фильтра, разделив пары key=value амперсандами (&):

your_embedding_url?breakfast=Scrambled_eggs&breakfast=Bacon

Ограничение данных в подписанном встраивании¶

Если вы хотите ограничить данные, отображаемые на встроенном дашборде или в вопросе SQL, вы можете настроить заблокированный параметр. Заблокированный параметр фильтрует данные дашборда или в вопросе SQL перед тем, как результаты отображаются конечному пользователю в подписанном внедрении.

Вы можете использовать заблокированные параметры для отображения отфильтрованных данных на основе атрибутов, полученных вашим веб-сервером, таких, как имя пользователя или идентификатор пользователя. Дополнительные примеры см. в репозитории приложений, документации open source Metabase.

Перейдите на дашборд или на вопрос SQL. Убедитесь, что вы настроили фильтр дашборда или переменную SQL.
Нажмите на значок общего доступа > Встроить этот элемент в приложение.
В разделе Параметры вы найдете имена фильтров вашего дашборда или переменных SQL.
Выберите Заблокировано для каждого параметра, которым вы хотите ограничить свои данные.
Добавьте значение для фильтра в разделе Предварительный просмотр заблокированных параметров.
Нажмите Опубликовать, чтобы сохранить изменения.
Добавьте или обновите код на своем сервере, чтобы он соответствовал коду, сгенерированному GlarusBI.

Заблокированные параметры будут применять выбранные значения фильтра к вашему исходному дашборду или вопросу SQL, но они не будут отображаться в виде виджетов фильтра во встраивании. Заблокированные параметры также могут ограничивать значения, отображаемые в ваших встроенных виджетах фильтров.

Заблокированные параметры на дашбордах с вопросами SQL¶

Если ваш заблокированный параметр связан с фильтром дашборда, который, в свою очередь, связан с вопросом SQL, вы сможете выбрать только одно значение для заблокированного параметра.

Например, предположим, что у вас есть фильтр дашборда под названием «Завтрак» со значениями «Яичница-болтунья», «Бекон» и «Вафли». Если фильтр «Завтрак» связан с любыми вопросами SQL на панели инструментов, вы сможете выбрать только один из вариантов: «Яичница-болтунья», «Бекон» или «Вафли» для заблокированного параметра, связанного с фильтром «Завтрак».

Скрытие виджетов фильтров из подписанного встраивания¶

Если у вас много редактируемых параметров (что приводит к большому количеству виджетов фильтров), вы можете скрыть их из подписанного встраивания, добавив hide_parameters к URL-адресу встраивания.

Например, если вы хотите скрыть фильтр под названием «Завтрак» со встроенного дашборда:

your_embedding_url#hide_parameters=breakfast

Вы можете скрыть несколько виджетов фильтров, разделив имена параметров запятыми:

your_embedding_url#hide_parameters=breakfast,lunch

Вы также можете одновременно присвоить параметру значение по умолчанию и скрыть его виджет фильтра:

your_embedding_url?breakfast=Scrambled_eggs#hide_parameters=breakfast

Настройка внешнего вида подписанного встраивания¶

Вы можете изменить внешний вид встроенного элемента, добавив параметры со следующими значениями:

Вы можете предварительно просмотреть изменения в своем вопросе или на дашборде встроенные настройки внешнего вида.

Например, следующий URL-адрес для встраивания будет отображать встроенный элемент в темном режиме с исходным заголовком и без рамки:

your_embedding_url#theme=night&titled=true&bordered=false