DataSourceListProps

Interface

The DataSourceList component props.

Properties

changeInitStatus optional

changeInitStatus: function

Change data source init status, it will be necessary if the user is allowed to add new data source in the component.

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

className optional

className: string

only used by theme.

disableAddData optional

disableAddData: boolean

Whether to hide the add data button at bottom.

disableRemove optional

disableRemove: boolean

Before removing the component, this will check the variable to make sure it can continue removing.

disableSelection optional

disableSelection: boolean

Before selecting the component, this will check the variable to make sure it can continue selecting.

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.

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.

isDataSourceInited

isDataSourceInited: boolean

If true, data sources are inited.

isMultiple optional

isMultiple: boolean

Whether to support multiple selection.

onChange optional

onChange: function

Callback when selected data sources are changed.

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

onCloseClick optional

onCloseClick: function

Callback when close icon is clicked.

Type declaration
    (): void
    Returns 
    void

types

types: ImmutableArray<AllDataSourceTypes>

Supported data source types.

useDataSources optional

useDataSources: ImmutableArray<UseDataSource>

Selected data sources.

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.