> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Components

## CellSetTable

Displays a table representing a CellSet.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<CellSetTable
  Cell={Cell}
  containerStyle={containerStyle}
  data={data}
  hideRedundantTotals={hideRedundantTotals}
  isRowHeaderTree={isRowHeaderTree}
  onChange={onChange}
  onRowsActioned={onRowsActioned}
  onScroll={onScroll}
  onSelectionChange={onSelectionChange}
  onVisibleRangeChanged={onVisibleRangeChanged}
  widgetState={widgetState}
/>
```

### CellSetTableProps

| Property              | Type                                                                                                         | Description |
| :-------------------- | :----------------------------------------------------------------------------------------------------------- | :---------- |
| Cell                  | ForwardRefExoticComponent\<PropsWithRef\<[CellSetTableCellProps](types#cellsettablecellprops)>>              |             |
| containerStyle        | CSSProperties                                                                                                |             |
| data                  | [CellSet](types#cellset)                                                                                     |             |
| hideRedundantTotals   | boolean                                                                                                      |             |
| isRowHeaderTree       | boolean                                                                                                      |             |
| onChange              | (updatedWidgetState: [TableWidgetState](types#tablewidgetstate)) => void                                     |             |
| onRowsActioned        | (tuples: [Tuple](types#tuple)\[]) => void                                                                    |             |
| onScroll              | (newPosition: \{<br />   scrollTop: number;<br />   scrollLeft: number; <br />}) => void                     |             |
| onSelectionChange     | (newSelection: [CellSetSelection](types#cellsetselection), newLowLevelSelection: AnchoredRange2D\[]) => void |             |
| onVisibleRangeChanged | (visibleRange: [Range2D](types#range2d)) => void                                                             |             |
| widgetState           | [TableWidgetState](types#tablewidgetstate)                                                                   |             |

## CenteredTitle

Displays a title, centered horizontally and vertically within its parent Component.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<CenteredTitle
	{...}
/>
```

## Collapsible

A component that wraps a collapsible component, allowing to toggle between collapsed and expanded.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Collapsible
	{...}
/>
```

## ContentNodeIcon

Displays the icon on the left of nodes in content trees. Represents a server, a folder or a file.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<ContentNodeIcon
	{...}
/>
```

## ContentTree

Displays a tree of saved widgets or dashboards

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<ContentTree
  areFilesVisible={areFilesVisible}
  className={className}
  ContentNodeIcon={ContentNodeIcon}
  contextMenuItems={contextMenuItems}
  doesSelectionIncludeChildren={doesSelectionIncludeChildren}
  expandTrigger={expandTrigger}
  getDefaultCaption={getDefaultCaption}
  getDragItem={getDragItem}
  hoverStyle={hoverStyle}
  isSearchVisible={isSearchVisible}
  isSelectable={isSelectable}
  lineHeight={lineHeight}
  nodeStyle={nodeStyle}
  onClick={onClick}
  searchPlaceholder={searchPlaceholder}
  selectedPaths={selectedPaths}
  selectionStyle={selectionStyle}
  structure={structure}
/>
```

### ContentTreeProps

| Property                     | Type                                                                             | Description                                                                                                                                                                        |
| :--------------------------- | :------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| areFilesVisible              | boolean                                                                          |                                                                                                                                                                                    |
| className                    | string                                                                           |                                                                                                                                                                                    |
| ContentNodeIcon              | FC\<[NodeIconProps](types#nodeiconprops)\<[ContentNode](types#contentnode)\<T>>> |                                                                                                                                                                                    |
| contextMenuItems             | ItemType\[]                                                                      |                                                                                                                                                                                    |
| doesSelectionIncludeChildren | boolean                                                                          |                                                                                                                                                                                    |
| expandTrigger                | [TreeProps](components#treeprops)\["expandTrigger"]                              | Whether folder nodes can be opened by clicking on their full name, or only on the caret on their left. By default, they can be opened only by clicking on the caret on their left. |
| getDefaultCaption            | (node?: [ContentNode](types#contentnode)\<T>) => string                          |                                                                                                                                                                                    |
| getDragItem                  | (id: string, metaData: T) => void                                                |                                                                                                                                                                                    |
| hoverStyle                   | CSSProperties                                                                    |                                                                                                                                                                                    |
| isSearchVisible              | boolean                                                                          |                                                                                                                                                                                    |
| isSelectable                 | boolean                                                                          |                                                                                                                                                                                    |
| lineHeight                   | number                                                                           |                                                                                                                                                                                    |
| nodeStyle                    | CSSProperties                                                                    |                                                                                                                                                                                    |
| onClick                      | (node: [ContentNode](types#contentnode)\<T>, path: number\[]) => void            |                                                                                                                                                                                    |
| searchPlaceholder            | string                                                                           |                                                                                                                                                                                    |
| selectedPaths                | number\[]\[]                                                                     |                                                                                                                                                                                    |
| selectionStyle               | CSSProperties                                                                    |                                                                                                                                                                                    |
| structure                    | [ContentRecord](types#contentrecord)\<T>                                         |                                                                                                                                                                                    |

## CreateFolderModal

Displays a modal to create a folder.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<CreateFolderModal
	{...}
/>
```

## Dashboard

Renders multiple resizable and draggable data exploration widgets.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Dashboard
  isBrandSignatureVisible={isBrandSignatureVisible}
  isDeferred={isDeferred}
  onIsDeferredChange={onIsDeferredChange}
/>
```

### DashboardProps

| Property                | Type                        | Description                                                                                               |
| :---------------------- | :-------------------------- | :-------------------------------------------------------------------------------------------------------- |
| isBrandSignatureVisible | boolean                     | If not <code>false</code>, \*By ActiveViam\* will be visible in the bottom right corner of the dashboard. |
| isDeferred              | boolean                     |                                                                                                           |
| onIsDeferredChange      | (newState: boolean) => void |                                                                                                           |

## DataModelTree

Displays the tree of measures and dimensions contained in a cube.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<DataModelTree
  cubeName={cubeName}
  mdx={mdx}
  serverKey={serverKey}
  className={className}
  disabledKpiProperties={disabledKpiProperties}
  disabledLevels={disabledLevels}
  disabledMeasures={disabledMeasures}
  marginLeft={marginLeft}
  measureGroupName={measureGroupName}
  onCubeSelected={onCubeSelected}
  onMeasureGroupSelected={onMeasureGroupSelected}
  searchInputRef={searchInputRef}
  selectedLeafKey={selectedLeafKey}
/>
```

### DataModelTreeProps

| Property               | Type                                                                     | Description                                                             |
| :--------------------- | :----------------------------------------------------------------------- | :---------------------------------------------------------------------- |
| cubeName               | [CubeName](types#cubename)                                               |                                                                         |
| mdx                    | [MdxSelect](types#mdxselect) \| [MdxDrillthrough](types#mdxdrillthrough) | If provided, <code>mdx</code> controls which cube options are disabled. |
| serverKey              | string                                                                   |                                                                         |
| className              | string                                                                   |                                                                         |
| disabledKpiProperties  | [KpiProperty](types#kpiproperty)\[]                                      |                                                                         |
| disabledLevels         | [LevelCoordinates](types#levelcoordinates)\[]                            |                                                                         |
| disabledMeasures       | [MeasureName](types#measurename)\[]                                      |                                                                         |
| marginLeft             | number                                                                   |                                                                         |
| measureGroupName       | string                                                                   |                                                                         |
| onCubeSelected         | (serverKey: string, cubeName: [CubeName](types#cubename)) => void        |                                                                         |
| onMeasureGroupSelected | (measureGroupName?: string) => void                                      |                                                                         |
| searchInputRef         | \{<br />   current: InputRef \| null; <br />}                            |                                                                         |
| selectedLeafKey        | string                                                                   |                                                                         |

## DataVisualizationBehaviorEditor

Allows the user to choose a template dashboard page, allowing to perform investigations on data points from the selected widget, thanks to the pluginMenuItemInvestigate.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<DataVisualizationBehaviorEditor
	{...}
/>
```

## DataVisualizationContentEditor

Displays a data model tree and a wizard, allowing to add levels and measures to the selected widget's attributes.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<DataVisualizationContentEditor
	{...}
/>
```

### DataVisualizationContentEditorProps

[EditorProps](types#editorprops)\<[DataVisualizationWidgetState](types#datavisualizationwidgetstate)> & \{<br />   extraSection?: JSX.Element;<br />   onTileMovedFromExtraSection?: (args: \{<br />     dragItem: any;<br />     toPosition: [TilePositionWithinWizard](types#tilepositionwithinwizard); <br />  }) => void; <br />}

## DataVisualizationQueryEditor

Displays an MdxEditor hooked to the selected widget.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<DataVisualizationQueryEditor
	{...}
/>
```

## DefaultTableCell

Displays a cell in a table. This behavior can be overridden by passing a `Cell` prop to `Table`.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<DefaultTableCell
	{...}
/>
```

## DrillthroughTable

Displays the result of an [MdxDrillthrough](types#mdxdrillthrough) query in a table.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<DrillthroughTable
	{...}
/>
```

### DrillthroughTableProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[DrillthroughTableWidgetState](types#drillthroughtablewidgetstate), [DrillthroughResult](types#drillthroughresult), [DrillthroughSelection](types#drillthroughselection), [Tuple](types#tuple)\[], AnchoredRange2D\[]>

## FiltersEditor

Displays a hierarchy tree and a filter wizard. Either stacked horizontally or vertically, depending on how wide the parent is.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<FiltersEditor
	{...}
/>
```

### FiltersEditorProps

* [EditorProps](types#editorprops)\<WidgetState> & [EditorProps](types#editorprops)\<WidgetState> & \{ queryType?: "drillthrough"
* "select"; }

## FormRow

<Warning>
  **Deprecated**

  Use Ant Design's Form and Form.Item components instead.
</Warning>

Displays a styled row with a label on the left and an input on the right, useful in a form.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<FormRow
	{...}
/>
```

## HighlightedSearchResult

Displays the label of a search result, highlighting the matched part of it.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<HighlightedSearchResult
  caption={caption}
  className={className}
  isDisabled={isDisabled}
  searchValue={searchValue}
  captionStyle={captionStyle}
  path={path}
  pathStyle={pathStyle}
/>
```

### HighlightedSearchResultProps

| Property     | Type      | Description |
| :----------- | :-------- | :---------- |
| caption      | string    |             |
| className    | string    |             |
| isDisabled   | boolean   |             |
| searchValue  | string    |             |
| captionStyle | CSSObject |             |
| path         | string    |             |
| pathStyle    | CSSObject |             |

## KpiComponent

Displays one or several high level KPIs. Can optionally be used to display comparisons of KPIs, for instance across 2 dates or 2 scenarios.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<KpiComponent
	{...}
/>
```

### KpiComponentProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[KpiWidgetState](types#kpiwidgetstate)>

## KPIStatusTableCell

Displays a KPI Status cell in a table.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<KPIStatusTableCell
	{...}
/>
```

## LoadingBackground

The application loading background. It can be used as a placeholder while waiting for the asynchronous initialization of some React contexts for example.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<LoadingBackground
	{...}
/>
```

## PivotTable

Displays a pivot table.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PivotTable
	{...}
/>
```

### PivotTableProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[TableWidgetState](types#tablewidgetstate), [CellSet](types#cellset), [CellSetSelection](types#cellsetselection), [Tuple](types#tuple)\[], AnchoredRange2D\[]> & \{<br />   hideRedundantTotals?: boolean;<br />   isRowHeaderTree?: boolean; <br />}

## Plotly100StackedAreaChart

Displays a Plotly stacked area chart, normalized in order to highlight the relative contribution of each series to each point on the X axis.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Plotly100StackedAreaChart
	{...}
/>
```

### Plotly100StackedAreaChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## Plotly100StackedBarChart

Displays a Plotly stacked bar chart, normalized in order to highlight the relative contribution of each series to each point on the Y axis.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Plotly100StackedBarChart
	{...}
/>
```

### Plotly100StackedBarChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## Plotly100StackedColumnChart

Displays a Plotly stacked column chart, normalized in order to highlight the relative contribution of each series to each point on the X axis.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Plotly100StackedColumnChart
	{...}
/>
```

### Plotly100StackedColumnChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyAreaChart

Displays a Plotly area chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyAreaChart
	{...}
/>
```

### PlotlyAreaChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyBulletChart

Displays a Plotly bullet chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyBulletChart
	{...}
/>
```

### PlotlyBulletChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyClusteredBarChart

Displays a Plotly clustered bar chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyClusteredBarChart
	{...}
/>
```

### PlotlyClusteredBarChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyClusteredColumnChart

Displays a Plotly clustered column chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyClusteredColumnChart
	{...}
/>
```

### PlotlyClusteredColumnChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyColumnsAndLinesChart

Displays a Plotly "columns and lines" chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyColumnsAndLinesChart
	{...}
/>
```

### PlotlyColumnsAndLinesChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyDonutChart

Displays a Plotly donut chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyDonutChart
	{...}
/>
```

### PlotlyDonutChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyPieWidgetState](types#plotlypiewidgetstate)>

## PlotlyGaugeChart

Displays a Plotly gauge chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyGaugeChart
	{...}
/>
```

### PlotlyGaugeChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyLineChart

Displays a Plotly line chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyLineChart
	{...}
/>
```

### PlotlyLineChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyPieChart

Displays a Plotly pie chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyPieChart
	{...}
/>
```

### PlotlyPieChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyPieWidgetState](types#plotlypiewidgetstate)>

## PlotlyRadarChart

Displays a Plotly radar chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyRadarChart
	{...}
/>
```

### PlotlyRadarChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyScatterPlot

Displays a Plotly scatter plot.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyScatterPlot
	{...}
/>
```

### PlotlyScatterPlotProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyStackedAreaChart

Displays a Plotly stacked area chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyStackedAreaChart
	{...}
/>
```

### PlotlyStackedAreaChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyStackedBarChart

Displays a Plotly stacked bar chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyStackedBarChart
	{...}
/>
```

### PlotlyStackedBarChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyStackedColumnChart

Displays a Plotly stacked column chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyStackedColumnChart
	{...}
/>
```

### PlotlyStackedColumnChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyTreeMap

Displays a Plotly treemap.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyTreeMap
	{...}
/>
```

### PlotlyTreeMapProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## PlotlyWaterfallChart

Displays a Plotly waterfall chart.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<PlotlyWaterfallChart
	{...}
/>
```

### PlotlyWaterfallChartProps

[WidgetWithQueryProps](types#widgetwithqueryprops)\<[PlotlyWidgetState](types#plotlywidgetstate)>

## Resizable

Accepts two children. Displays them next to each other. The first one is resizable.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Resizable
  children={children}
  className={className}
  direction={direction}
  dragHandleStyle={dragHandleStyle}
  firstChildStyle={firstChildStyle}
  isResizingDisabled={isResizingDisabled}
  minSize={minSize}
  onResized={onResized}
  onResizeEnd={onResizeEnd}
  secondChildStyle={secondChildStyle}
  size={size}
  style={style}
/>
```

### ResizableProps

| Property           | Type                      | Description |
| :----------------- | :------------------------ | :---------- |
| children           | \[ReactNode, ReactNode]   |             |
| className          | string                    |             |
| direction          | "column" \| "row"         |             |
| dragHandleStyle    | CSSProperties             |             |
| firstChildStyle    | CSSProperties             |             |
| isResizingDisabled | boolean                   |             |
| minSize            | number                    |             |
| onResized          | (newSize: number) => void |             |
| onResizeEnd        | (newSize: number) => void |             |
| secondChildStyle   | CSSProperties             |             |
| size               | number                    |             |
| style              | CSSProperties             |             |

## SaveAsPopup

A popup which allows a user to save a dashboard, widget or filter as a new content file. The user must choose a folder and name for the file and can also share it with other users if he has the `canShare` permission.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<SaveAsPopup
  contentTree={contentTree}
  contentType={contentType}
  defaultName={defaultName}
  isVisible={isVisible}
  onClose={onClose}
  onSubmit={onSubmit}
  pathToParentFolder={pathToParentFolder}
/>
```

### SaveAsPopupProps

| Property           | Type                                                                                                                                 | Description |
| :----------------- | :----------------------------------------------------------------------------------------------------------------------------------- | :---------- |
| contentTree        | [ContentRecord](types#contentrecord)\<[AMetaData](types#ametadata)> \| null                                                          |             |
| contentType        | [ContentType](types#contenttype)                                                                                                     |             |
| defaultName        | string                                                                                                                               |             |
| isVisible          | boolean                                                                                                                              |             |
| onClose            | (event: MouseEvent) => void                                                                                                          |             |
| onSubmit           | (name: string, pathToParentFolder: [ServerPath](types#serverpath), permissions: [Permission](types#permission)\[]) => Promise\<void> |             |
| pathToParentFolder | [ServerPath](types#serverpath)                                                                                                       |             |

## ShareForm

A form to allow sharing dashboards, widgets and filters between users.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<ShareForm
  isDisabled={isDisabled}
  onPermissionsChange={onPermissionsChange}
  permissions={permissions}
/>
```

### ShareFormProps

| Property            | Type                                                     | Description |
| :------------------ | :------------------------------------------------------- | :---------- |
| isDisabled          | boolean                                                  |             |
| onPermissionsChange | (permissions: [Permission](types#permission)\[]) => void |             |
| permissions         | [Permission](types#permission)\[]                        |             |

## Title

A component that wraps antd's Title and allows us to customize its style.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Title disabled={disabled} level={level} />
```

### TitleProps

| Property | Type                       | Description |
| :------- | :------------------------- | :---------- |
| disabled | boolean                    |             |
| level    | 1 \| 2 \| 3 \| 4 \| 5 \| 6 |             |

## TitleInput

Displays an editable title. Used for dashboard and widget names.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<TitleInput
  className={className}
  inputCss={inputCss}
  isPlaceholder={isPlaceholder}
  isStrictlySized={isStrictlySized}
  onChange={onChange}
  tooltipValue={tooltipValue}
  value={value}
/>
```

### TitleInputProps

| Property        | Type                       | Description |
| :-------------- | :------------------------- | :---------- |
| className       | string                     |             |
| inputCss        | CSSObject                  |             |
| isPlaceholder   | boolean                    |             |
| isStrictlySized | boolean                    |             |
| onChange        | (newValue: string) => void |             |
| tooltipValue    | string                     |             |
| value           | string                     |             |

## Tree

Renders nested structures such as saved dashboards or data model trees.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Tree
  areEmptyFoldersExpandable={areEmptyFoldersExpandable}
  autoFocusSearchInput={autoFocusSearchInput}
  className={className}
  contextMenuItems={contextMenuItems}
  defaultExpandedPaths={defaultExpandedPaths}
  doesSelectionIncludeChildren={doesSelectionIncludeChildren}
  doSearchResultsIncludeFolders={doSearchResultsIncludeFolders}
  expandedPaths={expandedPaths}
  expandTrigger={expandTrigger}
  flatValue={flatValue}
  focusedIndex={focusedIndex}
  getDefaultCaption={getDefaultCaption}
  hasCheckbox={hasCheckbox}
  hoverStyle={hoverStyle}
  isFullyExpanded={isFullyExpanded}
  isLoading={isLoading}
  isSearchLoading={isSearchLoading}
  isSearchVisible={isSearchVisible}
  isSelectable={isSelectable}
  lineHeight={lineHeight}
  Node={Node}
  NodeIcon={NodeIcon}
  nodeStyle={nodeStyle}
  onClick={onClick}
  onExpandedPathsChange={onExpandedPathsChange}
  onFocusedIndexChanged={onFocusedIndexChanged}
  onNodeEditEnded={onNodeEditEnded}
  onSearchValueChanged={onSearchValueChanged}
  onSelectedPathsChange={onSelectedPathsChange}
  overscanCount={overscanCount}
  searchInputAction={searchInputAction}
  searchInputRef={searchInputRef}
  searchPlaceholder={searchPlaceholder}
  searchResults={searchResults}
  searchResultsDisplayShape={searchResultsDisplayShape}
  searchValue={searchValue}
  selectedPaths={selectedPaths}
  selectionMode={selectionMode}
  selectionStyle={selectionStyle}
  style={style}
  value={value}
/>
```

### TreeProps

| Property                      | Type                                                                                                              | Description                                                                                                                                                                        |
| :---------------------------- | :---------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| areEmptyFoldersExpandable     | boolean                                                                                                           |                                                                                                                                                                                    |
| autoFocusSearchInput          | boolean                                                                                                           |                                                                                                                                                                                    |
| className                     | string                                                                                                            |                                                                                                                                                                                    |
| contextMenuItems              | ItemType\[]                                                                                                       |                                                                                                                                                                                    |
| defaultExpandedPaths          | number\[]\[]                                                                                                      |                                                                                                                                                                                    |
| doesSelectionIncludeChildren  | boolean                                                                                                           |                                                                                                                                                                                    |
| doSearchResultsIncludeFolders | boolean                                                                                                           |                                                                                                                                                                                    |
| expandedPaths                 | number\[]\[]                                                                                                      |                                                                                                                                                                                    |
| expandTrigger                 | "caret" \| "full-node" \| ((node: NodeType) => "caret" \| "full-node")                                            | Whether folder nodes can be opened by clicking on their full name, or only on the caret on their left. By default, they can be opened only by clicking on the caret on their left. |
| flatValue                     | [InternalNode](types#internalnode)\<NodeType>\[]                                                                  | <code>flatValue</code> is useful when <code>searchValue</code> is controlled. In this case, it is needed by the Tree's parent in order to compute <code>searchResults</code>.      |
| focusedIndex                  | number                                                                                                            |                                                                                                                                                                                    |
| getDefaultCaption             | (node?: NodeType) => string                                                                                       |                                                                                                                                                                                    |
| hasCheckbox                   | (node: NodeType) => boolean                                                                                       |                                                                                                                                                                                    |
| hoverStyle                    | CSSProperties                                                                                                     |                                                                                                                                                                                    |
| isFullyExpanded               | boolean                                                                                                           | Whether all parent nodes in the tree are expanded. When <code>true</code>, the user is not allowed to collapse any node.                                                           |
| isLoading                     | boolean                                                                                                           |                                                                                                                                                                                    |
| isSearchLoading               | boolean                                                                                                           |                                                                                                                                                                                    |
| isSearchVisible               | boolean                                                                                                           |                                                                                                                                                                                    |
| isSelectable                  | boolean                                                                                                           |                                                                                                                                                                                    |
| lineHeight                    | number                                                                                                            |                                                                                                                                                                                    |
| Node                          | ComponentType\<[NodeProps](types#nodeprops)\<NodeType>>                                                           |                                                                                                                                                                                    |
| NodeIcon                      | ComponentType\<[NodeIconProps](types#nodeiconprops)\<NodeType>>                                                   |                                                                                                                                                                                    |
| nodeStyle                     | CSSProperties                                                                                                     |                                                                                                                                                                                    |
| onClick                       | (node: NodeType, path: number\[], event: MouseEvent\<HTMLDivElement> \| KeyboardEvent\<HTMLInputElement>) => void |                                                                                                                                                                                    |
| onExpandedPathsChange         | (newExpandedPaths: number\[]\[], expansionAction: [ExpansionAction](types#expansionaction)) => void               |                                                                                                                                                                                    |
| onFocusedIndexChanged         | (newFocusedIndex: number) => void                                                                                 |                                                                                                                                                                                    |
| onNodeEditEnded               | (path: number\[], caption: string) => void                                                                        |                                                                                                                                                                                    |
| onSearchValueChanged          | (newSearchValue: string) => void                                                                                  |                                                                                                                                                                                    |
| onSelectedPathsChange         | (newSelectedPaths: number\[]\[]) => void                                                                          |                                                                                                                                                                                    |
| overscanCount                 | number                                                                                                            |                                                                                                                                                                                    |
| searchInputAction             | ReactNode                                                                                                         |                                                                                                                                                                                    |
| searchInputRef                | Ref\<InputRef>                                                                                                    |                                                                                                                                                                                    |
| searchPlaceholder             | string                                                                                                            |                                                                                                                                                                                    |
| searchResults                 | [InternalNode](types#internalnode)\<NodeType>\[]                                                                  |                                                                                                                                                                                    |
| searchResultsDisplayShape     | "tree" \| "list"                                                                                                  |                                                                                                                                                                                    |
| searchValue                   | string                                                                                                            |                                                                                                                                                                                    |
| selectedPaths                 | number\[]\[]                                                                                                      |                                                                                                                                                                                    |
| selectionMode                 | "single" \| "multiple"                                                                                            |                                                                                                                                                                                    |
| selectionStyle                | CSSProperties                                                                                                     |                                                                                                                                                                                    |
| style                         | CSSProperties                                                                                                     |                                                                                                                                                                                    |
| value                         | [TreeObject](types#treeobject)\<NodeType>\[]                                                                      |                                                                                                                                                                                    |

## Widget

Displays the [WidgetPlugin](types#widgetplugin) identified by the given `widgetKey` in the [PluginRegistry](types#pluginregistry) provided by the closest `PluginsProvider`.

```jsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
<Widget
  isDeferred={isDeferred}
  isSelected={isSelected}
  onChange={onChange}
  onLoaded={onLoaded}
  onSelectionChange={onSelectionChange}
  queryId={queryId}
  style={style}
  widgetState={widgetState}
/>
```

### WidgetProps

| Property          | Type                                                                                | Description |
| :---------------- | :---------------------------------------------------------------------------------- | :---------- |
| isDeferred        | boolean                                                                             |             |
| isSelected        | boolean                                                                             |             |
| onChange          | (newState: WidgetState) => void                                                     |             |
| onLoaded          | () => void                                                                          |             |
| onSelectionChange | (newSelection: SelectionType, newLowLevelSelection?: LowLevelSelectionType) => void |             |
| queryId           | string                                                                              |             |
| style             | CSSProperties                                                                       |             |
| widgetState       | WidgetState                                                                         |             |