✅ You are viewing documentation for the latest version of Compose SDK.

Version:

# Type alias DataOptionLocation

DataOptionLocation: object

Location within component data options that identifies a specific data option.

# Example

{ dataOptionName: 'category', dataOptionIndex: 0 } // First category
{ dataOptionName: 'value', dataOptionIndex: 1 }    // Second value measure

# Type declaration

# `dataOptionIndex`

dataOptionIndex?: number

Data option location zero-based index.

Required for array-based locations (e.g., rows, columns, values, category). Optional for single-value locations (e.g., x, y, date).

# Default

# `dataOptionName`

dataOptionName: "breakBy" | "breakByColor" | "breakByPoint" | "category" | "color" | "colorBy" | "columns" | "date" | "details" | "geo" | "max" | "min" | "outliers" | "rows" | "secondary" | "size" | "value" | "values" | "x" | "y"

Data option location name that identifies the property containing the data option.

Examples:

PivotTable: 'rows' | 'columns' | 'values'
Cartesian charts: 'category' | 'value' | 'breakBy'
Scatter charts: 'x' | 'y' | 'breakByPoint' | 'breakByColor' | 'size'