Skip to content

Commit

Permalink
Added descriptions to the Interaction Modes. (#829)
Browse files Browse the repository at this point in the history
Co-authored-by: Mischa Spelt <[email protected]>
  • Loading branch information
mhspelt and Mischa Spelt authored Sep 4, 2024
1 parent 0ab93a4 commit 2cc30bc
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions blazorbootstrap/Models/Charts/ChartOptions/ChartOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,34 @@ public InteractionMode Mode

public enum InteractionMode
{
/// <summary>
/// Finds items in the same dataset.
/// </summary>
Dataset,

/// <summary>
/// Finds item at the same index.
/// </summary>
Index,

/// <summary>
/// Gets the items that are at the nearest distance to the point.
/// </summary>
Nearest,

/// <summary>
/// Finds all of the items that intersect the point
/// </summary>
Point,

/// <summary>
/// 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.
/// </summary>
X,

/// <summary>
/// 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.
/// </summary>
Y
}

Expand Down

0 comments on commit 2cc30bc

Please sign in to comment.