FUIChartSelectionComponent
public protocol FUIChartSelectionComponent
Undocumented
-
Determines which plot items should be selected for a category.
- single : Selects a single value in the currently selected series and category indices.
- all : Selects one value in each series for the selected category index(es).
Declaration
Swift
var selectionMode: FUIChartSelectionMode { get set }
-
Default category selection mode for the chart. Defines how the initial selection is handled. Only valid values are selected. Used in combination with:
select(category:)
,select(categoriesInRange:)
,select(series:)
,select(dimension:)
. If no series is selected throughselect(series:)
, the first series will be used. For Scatter and Bubble charts, if no dimension is defined throughselect(dimension:)
, the Y axis dimension will be used.MCDefaultCategorySelectionIndex
This is the default behavior, where the given selection will be considered as the initial selection.MCDefaultCategorySelectionFirst
The first category will be considered as the default selection.MCDefaultCategorySelectionLast
The last gategory will be considered as the default selection.
Declaration
Swift
var defaultCategorySelectionMode: ChartDefaultCategorySelectionMode { get set }
-
When false a state is allowed in which no series is selected/active.
Declaration
Swift
var selectionRequired: Bool { get set }
-
The currently selected plot items for the FUIChartView (points, columns, bars, etc).
Declaration
Swift
var selections: [FUIChartPlotItem]? { get }
-
Selects a category at the given index. The resulting selection(s) depend on the current
selectionMode
.Declaration
Swift
func select(category categoryIndex: Int)
Parameters
categoryIndex
The index of the category to select.
-
Selects a category range, including the lower and and upper bounds of the range. The resulting selection(s) depend on the current
selectionMode
.Declaration
Swift
func select(categoriesInRange range: ClosedRange<Int>)
Parameters
range
The closed range of the categories to select.
-
Selects a series at the given index. The resulting selection(s) depend on the current
selectionMode
.Declaration
Swift
func select(series seriesIndex: Int)
Parameters
seriesIndex
The index of the series to select.
-
Steps through the series in incremental order.
- Works only wing
FUIChartSelectionMode.single
enabled. - If
selectionRequired
istrue
it will step through all series exluding the de-selected state. - If
selectionRequired
isfalse
it will step through all series including the de-selected state.
Declaration
Swift
func selectNextSeries()
- Works only wing
-
Selects a dimension at the given index for Scatter and bubble charts. The resulting selection(s) depend on the current
selectionMode
.Declaration
Swift
func select(dimension dimensionIndex: Int)
Parameters
dimension
The data dimension to select in Scatter (X: 0, Y: 1) and Bubble (X: 0, Y: 1, BubbleSize: 2).
-
Deselects all currently selected plot items in the FUIChartView.
Declaration
Swift
func clearSelections()