new GoResultsHighlighter(element, settingsopt)
Creates new Go Results Highlighter
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
element |
HTMLElement | element where the highlighter should be bound to, preferably a table or a pre element | |
settings |
object |
<optional> |
configuration of the highlighter |
- Source:
Members
(readonly) configuration :object
Contains current configuration of Go Results Highlighter
Type:
- object
- Source:
(readonly) element :HTMLElement
Contains reference to element with highlighter
Type:
- HTMLElement
- Source:
hovering :boolean
Informs whether the hovering is enabled.
Type:
- boolean
- Source:
(readonly) isHighlighting :boolean
Informs whether the any player is highlighted
Type:
- boolean
- Source:
(readonly) isRearranged :boolean
Informs whether the rows are rearranged to display results in compact
mode
Type:
- boolean
- Source:
(readonly) player :number|null
Contains placement of current highlighted player
Type:
- number | null
- Source:
(readonly) players :number
Contains count of player rows
Type:
- number
- Source:
rearranging :boolean
Informs whether the rearranging is enabled.
Type:
- boolean
- Source:
Methods
configure(settings)
Changes current configuration of the highlighter
Parameters:
Name | Type | Description |
---|---|---|
settings |
object |
- Source:
highlight(player, rearrangeopt, opponentopt)
Highlights player and his/hers opponents
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
player |
number | object | placement of the player or the object with properties containing player, rearrange and opponent fields | |
rearrange |
boolean |
<optional> |
whether to rearrange result rows |
opponent |
number |
<optional> |
opponent with whom the game should be highlighted |
- Source:
opponents(player) → {Array.<number>}
Gets opponents for the player on provided place.
Parameters:
Name | Type | Description |
---|---|---|
player |
number | placement of player to get the list of opponents |
- Source:
Returns:
- Type
- Array.<number>