Skip to content

Commit 2cc30bc

Browse files
mhspeltMischa Spelt
andauthored
Added descriptions to the Interaction Modes. (#829)
Co-authored-by: Mischa Spelt <[email protected]>
1 parent 0ab93a4 commit 2cc30bc

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

blazorbootstrap/Models/Charts/ChartOptions/ChartOptions.cs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,34 @@ public InteractionMode Mode
148148

149149
public enum InteractionMode
150150
{
151+
/// <summary>
152+
/// Finds items in the same dataset.
153+
/// </summary>
151154
Dataset,
155+
156+
/// <summary>
157+
/// Finds item at the same index.
158+
/// </summary>
152159
Index,
160+
161+
/// <summary>
162+
/// Gets the items that are at the nearest distance to the point.
163+
/// </summary>
153164
Nearest,
165+
166+
/// <summary>
167+
/// Finds all of the items that intersect the point
168+
/// </summary>
154169
Point,
170+
171+
/// <summary>
172+
/// Returns all items that would intersect based on the X coordinate of the position only. Would be useful for a vertical cursor implementation. Note that this only applies to cartesian charts.
173+
/// </summary>
155174
X,
175+
176+
/// <summary>
177+
/// Returns all items that would intersect based on the Y coordinate of the position. This would be useful for a horizontal cursor implementation. Note that this only applies to cartesian charts.
178+
/// </summary>
156179
Y
157180
}
158181

0 commit comments

Comments
 (0)