Список методов

Метод	Описание	С версии
new BX.SpotLight	Конструктор
spotlight.show	Показывает пульсирующий круг на странице.
spotlight.close	Скрывает пульсирующий круг на странице.
spotlight.adjustPosition	Пересчитывает координаты круга и перемещает его на новое положение.
spotlight.save	Сохраняет факт просмотра подсказки текущим пользователем.
spotlight.setTargetElement(targetElement)	Устанавливает элемент, около которого отобразится пульсирующий круг. targetElement {Element\|string} - DOM-элемент, либо id-атрибут DOM-элемента, либо селектор для поиска через document.querySelector.
spotlight.getTargetElement	Возвращает DOM-элемент, около которого позиционируется пульсирующий круг.
spotlight.bindEvents(events)	Устанавливает обработчики событий. events {object.} - Коллекция обработчиков событий.
spotlight.unbindEvents(events)	Удаляет обработчики событий. events {object.} - Коллекция обработчиков событий.
spotlight.getId	Возвращает уникальный идентификатор подсказки.
spotlight.setId(id)	Устанавливает уникальный идентификатор подсказки. id {string} - Идентификатор подсказки
spotlight.getZindex	Возвращает z-index пульсирующего круга.
spotlight.setZindex(zIndex)	Устанавливает z-index пульсирующего круга. zIndex {number} - z-index контейнера пульсирующего круга.
spotlight.getContent	Возвращает содержимое всплывающего диалога.
spotlight.setContent(content)	Устанавливает содержимое всплывающего диалога. content {Element\|string} - Cодержимое всплывающего диалога.
spotlight.getTargetVertex	Возвращает точку позиционирования.
spotlight.setTargetVertex(vertex)	Устанавливает точку позиционирования. vertex {string} - Идентификатор точки позиционирования. Допустимые значения: top-left- Верхний левый угол. Значение по умолчанию. top-center- Центральная точка верхней границы. top-right- Верхний правый угол. middle-left- Центральная точка левой границы. middle-center- Центральная точка элемента. middle-right- Центральная точка правой границы. bottom-left- Нижный левый угол. bottom-center- Центральная точка нижней границы. bottom-right - Нижний правый угол.
spotlight.getOffsetLeft	Возвращает смещение пульсирующего круга относительно точки позиционирования по оси абсцисс.
spotlight.setOffsetLeft(offset)	Устанавливает смещение пульсирующего круга в пикселях по оси абсцисс. offset {number} - Смещение по оси абсцисс в пикселях.
spotlight.getOffsetTop	Возвращает смещение пульсирующего круга относительно точки позиционирования по оси ординат.
spotlight.setOffsetTop(offset)	Устанавливает смещение пульсирующего круга в пикселях по оси ординат. offset {number} - Смещение по оси абсцисс в ординат.
spotlight.getLightMode	Возвращает true, если пульсирующий круг белого цвета.
spotlight.setLightMode([lightMode=true])	Устанавливает режим отображения. lightMode {boolean} - Если указано true, пульсирующий круг будет белого цвета, иначе серого цвета.
spotlight.getAutoSave	Возвращает true, если после показа диалога с подсказкой, данный факт будет зафиксирован в опциях текущего пользователя. Иначе false.
spotlight.setAutoSave([autoSave=true])	Устанавливает режим сохранения факта просмотра подсказки.
spotlight.getObserverTimeout	Возвращает таймаут проверки размеров в миллисекундах.
spotlight.setObserverTimeout(timeout)	Устанавливает таймаут проверки размеров в миллисекундах. timeout {number} - Таймаут проверки размеров в миллисекундах.
spotlight.getPopup	Возвращает ссылку (объект типа BX.PopupWindow) на высплывающий диалог с подсказкой.
spotlight.getTargetContainer	Возвращает ссылку (DOM-объект) на контейнер пульсирующего круга.