Namespace chip.visible
The namespace for the CHIP API's visible contract regarding the
CHIP's current visibility within the page.
Defined in: visible.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
chip.visible.attachVisible(fnEventHandler)
Attaches the given event handler to the "visible" event which is fired whenever the CHIP's
visibility has been changed.
|
| <static> |
chip.visible.isVisible()
Returns the CHIP's visibility within the page builder's page.
|
Method Detail
<static>
chip.visible.attachVisible(fnEventHandler)
Attaches the given event handler to the "visible" event which is fired whenever the CHIP's
visibility has been changed. The event handler takes a boolean as parameter, representing
the new visible state.
(Since 1.42) fnEventHandler is called once initially with the current visibility making it
unnecessary to check {#isVisible} when the CHIP is initialized. Attaching the same handler
multiple times will only result in one call to it.
- Parameters:
- {function (boolean)} fnEventHandler
- event handler for visibility changes
- Since:
- 1.17.0
<static>
{boolean}
chip.visible.isVisible()
Returns the CHIP's visibility within the page builder's page. The visibility is
true initially.
- Since:
- 1.17.0
- Returns:
- {boolean} the CHIP's visibility within the page builder's page.