Interface that is used to test whether a rendered item is deemed to be inside a rectangular marquee selection.
Inheritance Hierarchy
IMarqueeTestable
Related Programming Samples
- 07 Hit-Testing
- Customize which area of a node can be hovered and clicked
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IMarqueeTestable
See Also
Methods
Returns true if the corresponding item is considered to intersect the given rectangular box.
Remarks
This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.
Implementations should respect the hitTestRadius if marquee selections should behave differently on different zoom levels.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- the current input mode context
- rectangle - Rect
- the box describing the marquee's bounds
Returns
- ↪boolean
trueif the item is considered to be captured by the marquee
Constants
An implementation that always yields true.
An implementation that always yields false.
Static Methods
Creates an implementation of the interface IMarqueeTestable by using the given function as implementation for its isInBox method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- isInBox - function(IInputModeContext, Rect):boolean
- A function for IMarqueeTestable's single abstract method isInBox.
Returns
- ↪IMarqueeTestable
- An instance of the IMarqueeTestable interface based on the given function.