TreeMapBox.getLegends

Синтаксис

getLegends();

Описание

Метод getLegends возвращает объект с легендами плоского дерева.

Комментарии

Метод возвращает JSON-объект, свойства которых («Legend0», «Legend1» и так далее) содержат легенды плоского дерева.

Пример

Для выполнения примера необходимо наличие на html-странице компонента TreeMapBox с наименованием «treeMapBox» (см. «Пример создания компонента TreeMapBox»). Отобразим размерную легенду, если настройки сопоставления данных размерам элементов дерева определены:

// Получим размерную легенду
var sizeLegend = treeMapBox.getLegends()["Legend1"];
if (treeMapBox.getSizeVisual()) {
    // Отобразим размерную легенду
    sizeLegend.setIsVisible(true);
    // Установим размеры легенды
    sizeLegend.setSize(180, 75);
} else {
    sizeLegend.getIsVisible() ? console.log("Легенда отображена.") : console.log("Легенда скрыта.")
    console.log("Настройки сопоставления данных размерам элементов дерева не определены.");
};

Если размерная легенда плоского дерева недоступна или не определены настройки сопоставления данных размерам элементов дерева, то после выполнения примера в консоли браузера будут выведены соответствующие уведомления. Если эти настройки определены, то размерная легенда будет отображена.

См. также:

TreeMapBox