DataSourceSelectorProps

Interface

The DataSourceSelector component props.

Inheritance: DataSourceSelectorPropsOmit<DataSourceListPropsvoid | void | void | void | void>

Properties

buttonLabel optional

buttonLabel: string

Label of button, default is defaultMessages.setDataSource

closeDataSourceListOnChange optional

closeDataSourceListOnChange: boolean

Whether or not to close data source list panel after selecting data sources are changed

disableAddData optional

disableAddData: boolean

Whether to hide the add data button at bottom.

disableDataSourceList optional

disableDataSourceList: boolean

Whether or not to show data source list panel after clicking a selected data source

disableDataView optional

disableDataView: boolean

Whether or not to allow to select data view, the props will make data view dropdwon disabled.

disableRemove optional

disableRemove: function

Before remove, the component will call this method to check if it can continue removing

Type declaration
    (useDataSourcesUseDataSource[]): boolean
    Parameters
    • useDataSourcesUseDataSource[]
    Returns 
    boolean

disableSelection optional

disableSelection: function

Before selecting, the component will call this method to check if it can continue selecting

Type declaration
    (useDataSourcesUseDataSource[]): boolean
    Parameters
    • useDataSourcesUseDataSource[]
    Returns 
    boolean

enableToSelectOutputDsFromSelf optional

enableToSelectOutputDsFromSelf: boolean

Allow to select output data sources which are generated by current widget itself. Do not allow widgets to select these data sources by default.

fromDsIds optional

fromDsIds: ImmutableArray<string>

Only list these data sources.

fromRootDsIds optional

fromRootDsIds: ImmutableArray<string>

Only list child data sources generated by these root data sources.

hideDataView optional

hideDataView: boolean

Whether or not to hide the data view dropdwon, the props will make data view dropdwon hidden.

hideDs optional

hideDs: function

Whether to hide the data source in the list.

Type declaration
    (dsJsonImmutableObject<DataSourceJson>): boolean
    Parameters
    • dsJsonImmutableObject<DataSourceJson>
    Returns 
    boolean

hideHeader optional

hideHeader: boolean

Whether to hide header of the component.

hideTypeDropdown optional

hideTypeDropdown: boolean

Whether to hide dropdown that is used to filter the list by data source type.

isMultiple optional

isMultiple: boolean

Whether to support multiple selection.

mustUseDataSource optional

mustUseDataSource: boolean

Whether or not to show toggle data button, will hide toggle data button if the value is true

onChange optional

onChange: function

Callback when selected data sources are changed.

Type declaration
    (useDataSourcesUseDataSource[]): void
    Parameters
    • useDataSourcesUseDataSource[]
    Returns 
    void

onToggleUseDataEnabled optional

onToggleUseDataEnabled: function

Callback when toggle data button is clicked

Type declaration
    (useDataSourcesEnabledboolean): void
    Parameters
    • useDataSourcesEnabledboolean
    Returns 
    void

types

types: ImmutableArray<AllDataSourceTypes>

Supported data source types.

useDataSources optional

useDataSources: ImmutableArray<UseDataSource>

Selected data sources.

useDataSourcesEnabled optional

useDataSourcesEnabled: boolean

Whether or not to enable data source use

widgetId optional

widgetId: string

Must pass widgetId to use parent widget's data view by default when using the same data source as parent widget.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.