SankeyDiagram.hitTest Method

Determines what data control element is represented at the specified position.
 

Parameters

offsetX

Type: Number
The position to test in pixels relative to the left edge of the chart.
offsetY

Type: Number
The position to test in pixels relative to the top edge of the chart.
element

Type: HTMLElement
The HTML element located at the position, if available.
Optional: True

Return Value


Type: Object - May be null
If not null, a plain object with properties:
     type                                    [type: String]                          - type of cell
     rowOrdinals                             [type: Array]                           - the row tuple ordinals
     columnOrdinals                          [type: Array]                           - the column tuple ordinals
     nodes                                   [Type: Array]                           - selected nodes    
     relationshipMetricSetBindingId          [Type: String]                          - relationshipMetricSetBindingId
     infoMetricSetBindingId                  [Type: String]                          - infoMetricSetBindingId