Constructor
new ve.ce.SelectionManager.SelectionGroup(name, selectionManager)
#
SelectionGroup: Holds all data for a rendered selection group.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the selection group |
selectionManager |
ve.ce.SelectionManager | Selection manager |
- Source:
SelectionGroup: Holds all data for a rendered selection group.
Properties
fragments :Array.<ve.dm.SurfaceFragment>
#
selections :Array.<ve.ce.Selection>
#
visibleSelections :Array.<ve.ce.Selection>
#
Methods
addIdleCallback(callback)
#
Add an idle callback to be executed later
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | Callback function |
- Source:
Add an idle callback to be executed later
append(selectionElements)
#
Append selection elements to the DOM
Parameters:
| Name | Type | Description |
|---|---|---|
selectionElements |
ve.ce.SelectionManager.SelectionElements |
- Source:
Append selection elements to the DOM
cancelIdleCallbacks()
#
Cancel any pending idle callbacks
- Source:
Cancel any pending idle callbacks
empty()
#
Clear all rendered selections
- Source:
Clear all rendered selections
hasSelections() → {boolean}
#
Check if the selection group has some non-collapsed selections
- Source:
Returns:
- Type
- boolean
Check if the selection group has some non-collapsed selections
isClipped() → {boolean}
#
Check if the selection group is clipped
- Source:
Returns:
- Type
- boolean
Check if the selection group is clipped
setOptions(options)
#
Set the rendering options for this selection group
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
Set the rendering options for this selection group
setSelections(selections)
#
Set the selections for this selection group
Parameters:
| Name | Type | Description |
|---|---|---|
selections |
Array.<ve.ce.Selection> |
- Source:
Set the selections for this selection group
setVisibleSelections(visibleSelections)
#
Set the visible selections for this selection group
Must be a subset of the selections set by setSelections.
Parameters:
| Name | Type | Description |
|---|---|---|
visibleSelections |
Array.<ve.ce.Selection> |
- Source:
Set the visible selections for this selection group
Must be a subset of the selections set by setSelections.