new BX.SpotLight(
options
)
Function - constructor.
| Parameters | Description | Available from version |
| options {Object} | Set of options. Possible values:
- targetElement {Element|string} - Element, next to which the pulsating circle is displayed. Required option. Values can be a link or DOM element, or DOM element ID, or selector for searching via document.querySelector.
- targetVertex {string} - Top of targetElement, relative to which the Spotlight is positioned. Available values:
- top-left- Top left corner. Default value.
- top-center- Top central point.
- top-right- Top right corner.
- middle-left- Left border central point.
- middle-center- Element central point.
- middle-right- Right border central point.
- bottom-left- Low left corner.
- bottom-center- Lower border central point.
- bottom-right - Low right corner.
- content {Element|string} - Popup dialog content. String or DOM element. When this parameter is not specified, dialog won't be displayed.
- id {string} - Hint ID. Optional parameter. Used to save hint view by user.
- top {number} - Offset in pixels relative to targetVertex location point by y-axis. Default value is 0.
- left {number} - Offset in pixels relative to targetVertex location point by x-axis. Default value is 0.
- lightMode {boolean} - Light mode for Spotlight display. When true, pulsating circle is white.
- zIndex {number} - Z-index for pulsating circle. Default value is 1001.
- autoSave {boolean} - When true, registers a displayed dialog with hint in the current user options. Default value is false.
- observerTimeout {number} - Timeout for dimension check and targetElement position. Default value is 1000.
- events {object.} - Set of event handlers.
| |