Скрытие или отображение визуальных заголовков
Отчеты Power BI, внедренные в приложения, содержат визуальные элементы, такие как диаграммы, тепловые карты и датчики. Эти визуальные элементы имеют заголовки, которые делают действия доступными для пользователей. При использовании Power BI можно скрыть или показать заголовок каждого визуального элемента в отчете. Каждый визуальный элемент содержит карточку в разделе
Примеры действий в визуальных заголовках:
- Открытие визуального элемента в режиме фокусировки.
- Детализация или вверх.
- Просмотр фильтров и срезов, которые в настоящее время применяются к визуальному элементу.
- Открытие меню параметров визуального элемента.
Иногда полезно скрыть эти действия. Например, если два визуальных элемента перекрываются, может потребоваться не отображать заголовки обоих визуальных элементов.
Этот API предоставляет способ скрытия или отображения заголовков всех визуальных элементов в отчете или только определенных. Вы можете настроить видимость загрузки отчета или вызвать метод report updateSettings, чтобы изменить видимость после загрузки отчета, см. раздел Обновление параметров отчета во время выполнения.
Api можно использовать во многих сценариях, включая следующие варианты использования:
- Скрыть только некоторые визуальные заголовки в отчете.
- Используйте бизнес-логику в приложении, например нажатие кнопки, чтобы скрыть или показать заголовок после загрузки отчета.
Скрытие или отображение визуальных заголовков
Чтобы скрыть или показать визуальные заголовки в API, настройте определенные параметры в параметрах отчета. Общие сведения о настройке параметров отчетов в внедренных отчетах см. в
Параметры визуального заголовка
При использовании визуальных заголовков видимость в настоящее время является единственным параметром, который можно настроить. Чтобы скрыть или отобразить заголовки, укажите список объектов конфигурации визуального заголовка. Каждый из них содержит объект параметров и также может включать селектор. Селекторы определить визуальные элементы, к которым вы применяете параметры. Дополнительные сведения о селекторах селекторов.
Тип объекта конфигурации, предоставленного API, — IVisualSettings. Далее в этой статье вы найдете примеры, демонстрирующие использование этого интерфейса в коде. модели Power BI перечисляют все определения интерфейса, которые используются в примерах.
Обратите внимание на следующие моменты:
- Селектор является необязательным в этих параметрах. Если вы не перечисляете селекторы, API применяет параметры ко всем визуальным элементам отчета.
- При использовании селекторов можно указать визуальные элементы по имени или по типу. Чтобы получить имена и типы визуальных элементов на данной странице, используйте метод getVisual s
Page.
Правила приоритета
API применяет параметры конфигурации в следующем порядке:
- Параметры, сохраненные в отчете.
- Параметры, определенные в объекте конфигурации внедрения, который API применяется к нагрузке.
- Параметры, предоставляемые API
updateSettings.
Если к визуальному элементу может применяться несколько параметров, API использует последний параметр, который применяется. Скрыть все, кроме одного визуального заголовка в следующем разделе, иллюстрирует эту точку.
Примеры
В этих примерах показано, как использовать API для скрытия или отображения визуальных заголовков.
Скрытие всех визуальных заголовков
Этот простой сценарий предоставляет клиентам чистое представление отчета, скрывая все заголовки визуальных элементов в отчете:
let embedConfig = {
...
settings: {
...
visualSettings: {
visualHeaders: [
{
settings: {
visible: false
}
/* No selector is listed. The API hides the headers of all the visuals in the report. */
}
]
}
}
};
...
let report = powerbi.embed(embedContainer, embedConfig);
Скрытие заголовка конкретного визуального элемента
В этом примере используется селектор для применения параметра видимости к одному визуальному элементу. Этот сценарий возникает, когда вы хотите скрыть функциональные возможности, которые не имеют смысла для визуального элемента. Используйте этот код в этом случае:
let embedConfig = {
...
settings: {
...
visualSettings: {
visualHeaders: [
{
settings: {
visible: false
},
selector: {
$schema: "http://powerbi.com/product/schema#visualSelector",
visualName: <The name of the visual> // You can retrieve the name by using getVisuals.
}
}
]
}
}
};
...
let report = powerbi.embed(embedContainer, embedConfig);
Скрыть все, кроме одного визуального заголовка
Используйте этот код, чтобы скрыть все заголовки визуальных элементов в отчете, кроме заголовка конкретного визуального элемента:
let embedConfig = {
...
settings: {
...
visualSettings: {
visualHeaders: [
{
settings: {
visible: false
}
/* No selector is listed. The API hides the headers of all the visuals in the report. */
},
{
settings: {
visible: true
},
selector: {
$schema: "http://powerbi.com/product/schema#visualSelector",
visualName: <The name of the visual> // You can retrieve the name by using getVisuals.
}
}
]
}
}
};
...
let report = powerbi.embed(embedContainer, embedConfig);
Если вы хотите сделать несколько заголовков видимыми, можно расширить этот код. Настройте дополнительные экземпляры IVisualHeader с параметром visible в settings для параметра true. Для каждого визуального элемента, который должен иметь видимый заголовок, добавьте один экземпляр IVisualHeader в список.
Рекомендации и ограничения
- Вы можете управлять видимостью визуальных заголовков, только если отчет, внедренный в режим просмотра.
- Вы можете скрыть или показать весь заголовок визуального элемента. Невозможно настроить видимость определенных элементов в меню заголовка.
- При использовании селектора для указания имени или типа визуального элемента используйте метод getVisuals page getVisuals для получения имени визуального элемента, который является уникальным идентификатором. Не настраивайте селектор с заголовком визуального элемента.
- Если пользователь сохраняет отчет, внедренный с помощью API, то определенные визуальные параметры будут сохранены в отчете. Эту ситуацию можно избежать, настроив отчет с уровнем разрешений
ViewвместоEditилиSave.