Support class that allows to iterate over hits on table elements or subregions of table elements.
Inheritance Hierarchy
StripeHitTester
Type Details
- yfiles module
- view-table
- yfiles-umd modules
- view-table, view
- Legacy UMD name
- yfiles.input.StripeHitTester
See Also
Constructors
Create a new instance for a specific table instance that use the order specified by tableRenderingOrder to determine the order of the hit test results.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- table - ITable
- The table to use
- tableRenderingOrder - TableRenderingOrder
- The hit test order. This determines the order in which stripes are returned by enumerateHits
Properties
Gets the hit test order that is currently used by this instance
Methods
enumerateHits
(context: IInputModeContext, location: Point, node: INode) : IEnumerable<StripeSubregion>Return a collection of hits at location.
Remarks
This implementation returns the hits in the following order:
- First all IRows or IColumns at the given location, in the order specified by the tableRenderingOrder property.
- For each stripe type, the stripes are returned in bottom up order, i.e. children are returned before their parents.
- For each stripe, the subregions are returned in the order NEAR_BORDER, FAR_BORDER, LEADING_HEADER, TRAILING_HEADER,STRIPE, e.g. a header hit is always returned before a hit on the whole stripe.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context to use.
- location - Point
- The location in absolute coordinates.
- node - INode
- The node where the table instance is currently bound to.
Returns
- ↪IEnumerable<StripeSubregion>
- A collection of StripeSubregions at
location