Kap.Dashboard.getBlock

Синтаксис

getBlock (blockKey: String);

Параметры

blockKey. Ключ аналитической панели.

Описание

Метод getBlock возвращает блок аналитической панели по его ключу.

Комментарии

Ключ блока аналитической панели можно получить двумя способами:

1. Выделите блок, перейдите на заголовок боковой панели, наведите курсор на название блока. Появится всплывающая подсказка, содержащая название блока и его ключ:

2. Получить ключ нужного блока из метаданных, которые возвращаются при помощи метода Kap.Dashboard.getMeta.

Пример

Для выполнения примера предполагается наличие на странице конструктора аналитических панелей с наименованием «kapBox».Должна быть открыта аналитическая панель, содержащая как минимум один блок. В теге BODY должен содержаться элемент DIV с идентификатором «but». Добавим кнопки, при нажатии на которые из метаданных будет получен ключ первого блока аналитической панели и будет отображен заголовок этого блока:

            var mdButton = new PP.Ui.Button({
                ParentNode: "but",
                Content: "Ключ первого блока",
                Click: function () {
                    var block = kapBox.getMeta().Md.kap.block.prop[2].area[0];//получаем объект с ключом первого блока
                    console.log(block);//выводим в консоль объект с ключом первого блока
                }
            });
            var blockHeaderButton = new PP.Ui.Button({
                ParentNode: "but",
                Content: "Показать заголовок блока",
                Click: function () {
                    var blockOne = kapBox.getBlock("BBAXG4TUGYEHU5E7");//получаем блок по ключу
                    blockOne.setBlockTitleVisible(true);//отображаем заголовок блока
                }
            });

После выполнения примера на странице будут размещены кнопки «Ключ первого блока» и «Показать заголовок блока». При нажатии на кнопку «Ключ первого блока» в консоль браузера будет выведен JSON-объект со свойствами первого блока, например:

Object {@key: "BBAXG4TUGYEHU5E7", block: Object}

 

При нажатии на кнопку «Показать заголовок блока» будет отображен заголовок первого блока (ключ, выведенный в консоль при нажатии на кнопку «Ключ первого блока», должен быть установлен в качестве параметра метода getBlock).

См. также:

Kap.Dashboard