#cy.boxSelectionIncludesLabels()
// Check whether box selection includes labels
cy.boxSelectionIncludesLabels(): booleanWhether box selection considers label boxes as well as node bodies (default off). Its sense follows boxSelectionMode: under 'contain' the label box must also be inside the band, under 'overlap' a label that merely crosses the band is enough.
booleanthe current boxSelectionIncludesLabels value
#cy.boxSelectionIncludesLabels(bool)
// Include or exclude labels in box selection
cy.boxSelectionIncludesLabels(bool: boolean): thisWhether box selection considers label boxes as well as node bodies (default off). Its sense follows boxSelectionMode: under 'contain' the label box must also be inside the band, under 'overlap' a label that merely crosses the band is enough.
| Name | Description |
|---|---|
bool: boolean | the setting to apply |
thisthis core, for chaining
Example
const result = cy.boxSelectionIncludesLabels(false);console.log(result === cy); // true