sisense.com
✅ You are viewing documentation for the latest version of Compose SDK.
Version:

Interface CustomWidgetProps

Props for the Custom Widget component

Properties

Data

dataSource

dataSource?: DataSource

Data source the query is run against - e.g. Sample ECommerce

If not specified, the query will use the defaultDataSource specified in the parent Sisense Context.


filters

filters?: FilterRelations | Filter[]

Filters that will slice query results


highlights

highlights?: Filter[]

Filters that will highlight query results

Chart

dataOptions

dataOptions: GenericDataOptions

Configurations for how to interpret and present the data passed to the table

Widget

customOptions

customOptions?: Record< string, any >

Specific options for the custom widget.


customWidgetType

customWidgetType: string

Custom widget type. This is typically the name/ID of the custom widget.


description

description?: string

Description of the widget


styleOptions

styleOptions?: CustomWidgetStyleOptions

Style options for the custom widget.


title

title?: string

Title of the widget

Callbacks

onDataPointClick

onDataPointClick?: CustomWidgetDataPointEventHandler< AbstractDataPointWithEntries >

Click handler callback for a data point


onDataPointContextMenu

onDataPointContextMenu?: CustomWidgetDataPointContextMenuHandler< AbstractDataPointWithEntries >

Context menu handler callback for a data point


onDataPointsSelected

onDataPointsSelected?: CustomWidgetDataPointsEventHandler< AbstractDataPointWithEntries >

Handler callback for selection of multiple data points

Last Updated: