# Interface WidgetModel Fusion Embed

Model of Sisense widget defined in the abstractions of Compose SDK.

# Methods

# getChartProps

getChartProps(): ChartProps

Returns the props to be used for rendering a chart.

# Returns

ChartProps

# Example

<Chart {...widget.getChartProps()} />

Note: this method is not supported for pivot table widgets. Use getPivotTableProps instead for getting props for the <PivotTable> component.

Deprecated

Use widgetModelTranslator.toChartProps instead


# getChartWidgetProps

getChartWidgetProps(): ChartWidgetProps

Returns the props to be used for rendering a chart widget.

# Returns

ChartWidgetProps

# Example

<ChartWidget {...widget.getChartWidgetProps()} />

Note: this method is not supported for pivot widgets.


# getExecutePivotQueryParams

getExecutePivotQueryParams(): ExecutePivotQueryParams

Returns the parameters to be used for executing a query for the pivot widget.

# Returns

ExecutePivotQueryParams

# Example

const {data, isLoading, isError} = useExecutePivotQuery(widget.getExecutePivotQueryParams());

Note: this method is supported only for getting pivot query. Use getExecuteQueryParams instead for getting query parameters for non-pivot widgets.


# getExecuteQueryParams

getExecuteQueryParams(): ExecuteQueryParams

Returns the parameters to be used for executing a query for the widget.

# Returns

ExecuteQueryParams

# Example

const {data, isLoading, isError} = useExecuteQuery(widget.getExecuteQueryParams());

Note: this method is not supported for getting pivot query. Use getExecutePivotQueryParams instead for getting query parameters for the pivot widget.


# getPivotTableProps

getPivotTableProps(): PivotTableProps

Returns the props to be used for rendering a pivot table.

# Returns

PivotTableProps

# Example

<PivotTable {...widget.getPivotTableProps()} />

Note: this method is not supported for chart or table widgets. Use getChartProps instead for getting props for the <Chart> component. Use getTableProps instead for getting props for the <Table> component.


# getTableProps

getTableProps(): TableProps

Returns the props to be used for rendering a table.

# Returns

TableProps

# Example

<Table {...widget.getTableProps()} />

Note: this method is not supported for chart and pivot widgets. Use getChartProps instead for getting props for the <Chart> component. Use getPivotTableProps instead for getting props for the <PivotTable> component.

Deprecated

Use widgetModelTranslator.toTableProps instead


# getTextWidgetProps

getTextWidgetProps(): TextWidgetProps

Returns the props to be used for rendering a text widget.

# Returns

TextWidgetProps

# Example

<TextWidget {...widget.getTextWidgetProps()} />

Note: this method is not supported for chart or pivot widgets. Use getChartWidgetProps instead for getting props for the <ChartWidget> component. Use getPivotTableWidgetProps instead for getting props for the <PivotTableWidget> component.

# Properties

# chartType

chartType?: ChartType

Widget chart type.


# dataOptions

dataOptions: WidgetDataOptions

Widget data options.


# dataSource

dataSource: DataSource

Full name of the widget data source.


# description

description: string

Widget description.


# drilldownOptions

drilldownOptions: DrilldownOptions

Widget drilldown options.


# filters

filters: Filter[]

Widget filters.


# highlights

highlights: Filter[]

Widget highlights.


# oid

readonly oid: string

Unique identifier of the widget.


# pluginType

pluginType: string

Plugin type. Only present for plugin widgets.

If this is a plugin widget, this is typically the name/ID of the plugin.


# styleOptions

styleOptions: TextWidgetStyleOptions | ChartStyleOptions & WidgetContainerStyleOptions

Widget style options.


# title

title: string

Widget title.


# widgetType

widgetType: WidgetType

Widget type.

Deprecated

Use widgetModelTranslator methods instead