Constructor
new Tile(params)
Parameters:
Name | Type | Description |
---|---|---|
params |
Help4.widget.help.view2.Tile.Params |
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
__widget |
Help4.widget.help.Widget | ||
__view |
Help4.widget.help.view.View | ||
__container |
Help4.widget.help.view2.TileContainer | ||
__contentView |
Help4.control2.container.Container | ||
__tileView |
Help4.control2.container.Container | ||
projectTile |
Help4.widget.help.ProjectTile | ||
descriptor |
Help4.widget.help.view2.Tile.Descriptor | ||
whatsnew |
boolean | ||
tilePosition |
number | ||
widgetActive |
boolean | ||
hotspotStatus |
Object |
<nullable> |
|
stealth |
boolean | ||
tileControlId |
string |
<nullable> |
|
hotspotControlId |
string |
<nullable> |
|
bubbleControlId |
string |
<nullable> |
|
lightboxControlId |
string |
<nullable> |
|
_blockUpdate |
boolean | ||
_modified |
boolean | ||
_selected |
boolean | ||
_onPanelDock |
function |
- Source:
Extends
Methods
(protected) ____defineDataFunctions()
- Overrides:
- Source:
(protected) ____defineProperties(params, derivedopt, nullable)
Parameters:
Name | Type | Attributes | Default | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object | ||||||||||||
derived |
Object |
<optional> <nullable> |
null |
Properties
|
- Overrides:
- Source:
(protected) ____defineProperty(args)
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Object |
Properties
|
- Overrides:
- Source:
(protected) ____defineStaticProperties()
auto define all to be cleaned properties
- Overrides:
- Source:
Throws:
Error
(protected) ____extendParams(dest, src) → {Object}
Parameters:
Name | Type | Description |
---|---|---|
dest |
Object | |
src |
Object |
- Overrides:
- Source:
Returns:
- Type
- Object
(protected) ____getClassConfig() → {Help4.jscore.Base.Params}
- Overrides:
- Source:
Returns:
(protected) ____getData() → {Object}
- Overrides:
- Source:
Returns:
- Type
- Object
(protected) ____mergeDerivedParams(level0, level1)
Parameters:
Name | Type | Description |
---|---|---|
level0 |
Help4.jscore.Base.Params | |
level1 |
Help4.jscore.Base.Params |
- Overrides:
- Source:
Throws:
Error
(protected) ____resolveDerivedParams(classConfig)
Parameters:
Name | Type | Description |
---|---|---|
classConfig |
Help4.jscore.Base.Params |
- Overrides:
- Source:
(protected) ____setInitValue(args)
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Object |
Properties
|
- Overrides:
- Source:
(protected) _destroyControl(…keys)
destroys class properties
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
keys |
string |
<repeatable> |
- Overrides:
- Source:
(protected) _fireEvent(event) → {Help4.jscore.Base}
fires an event that can be observed from outside
Parameters:
Name | Type | Description |
---|---|---|
event |
Object | the event to be fired |
- Overrides:
- Source:
Returns:
- Type
- Help4.jscore.Base
(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}
fires an event that can be observed from outside
Parameters:
Name | Type | Description |
---|---|---|
event |
Object | the event to be fired |
- Overrides:
- Source:
Returns:
- Type
- Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>
(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}
fires an event that can be observed from outside
Parameters:
Name | Type | Description |
---|---|---|
event |
Object | the event to be fired |
- Overrides:
- Source:
Returns:
- Type
- Array.<Help4.EmbeddedEvent.EventResponse>
addListenerSync(eventType, listener) → {Help4.jscore.Base}
add an event listener
Parameters:
Name | Type | Description |
---|---|---|
eventType |
string | Array.<string> | event type to be observed |
listener |
Help4.EmbeddedEvent.Listener | the callback function |
- Overrides:
- Source:
Returns:
- Type
- Help4.jscore.Base
closeBubble()
causes deselection after bubble close
- Source:
destroy()
destroys this instance
- Overrides:
- Source:
equals(projectTile) → {boolean}
Parameters:
Name | Type | Description |
---|---|---|
projectTile |
Help4.widget.help.ProjectTile |
- Source:
Returns:
- Type
- boolean
getControl(controlId) → {Help4.control2.Control}
Parameters:
Name | Type | Description |
---|---|---|
controlId |
string |
- Source:
Returns:
hasHotspot() → {boolean}
- Source:
Returns:
- Type
- boolean
hover(hovered, delayopt) → {Promise.<boolean>|void}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
hovered |
boolean | |||
delay |
number |
<optional> |
0 |
- Source:
Returns:
- Type
- Promise.<boolean> | void
isDestroyed() → {boolean}
whether instance is destroyed
- Overrides:
- Source:
Returns:
- Type
- boolean
select(select) → {boolean}
Parameters:
Name | Type | Description |
---|---|---|
select |
boolean |
- Source:
Returns:
- Type
- boolean
stopHotspotAnimation() → {boolean}
- Source:
Returns:
- Type
- boolean
update(paramsopt) → {boolean}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
Object |
<optional> |
{} | see Help4.widget.help.view2.Tile.Params |
- Source:
Returns:
- Type
- boolean
wmHover(hovered)
Parameters:
Name | Type | Description |
---|---|---|
hovered |
boolean |
- Source:
Type Definitions
Descriptor
Type:
- string
- Source:
Params
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
widget |
Help4.widget.help.Widget | |||
view |
Help4.widget.help.view.View | |||
container |
Help4.widget.help.view2.TileContainer | |||
contentView |
Help4.control2.container.Container | |||
tileView |
Help4.control2.container.Container | |||
projectTile |
Help4.widget.help.ProjectTile | |||
whatsnew |
boolean | |||
tilePosition |
number |
<optional> |
0 | |
widgetActive |
boolean |
<optional> |
true | |
hotspotStatus |
Object |
<nullable> |
||
stealth |
boolean |
<optional> |
false |
- Source: