DatahubSelectorDialogConfig interface

The context object - where the user is - what workspace is in use, is it my workspace, etc.

contextInfo?: any

Property Value

Link below primary action button

datahubButtonLearnMoreLink?: { text: string, url: string }

Property Value

A dictionary where the key is DatahubItemType and the value is collection of DatahubButton[].

datahubButtonUserChoicesByType?: Partial<Record<string, DatahubButton[]>>

Property Value

Default button configuration that applies to all item types, shown even before selecting any item.

defaultButtonConfig?: DatahubButton[]

Property Value

The object Id's of the active selected items.

activeSelectedItemObjectIds?: string[]

Property Value

Inherited From DatahubCompactViewConfig.activeSelectedItemObjectIds

The selected item types to show in the table, subset of supportedTypes

activeTypes?: string[]

Property Value

Inherited From DatahubCompactViewConfig.activeTypes

whether to allow sort option – default is 'true'.

allowSort?: boolean

Property Value

Inherited From DatahubCompactViewConfig.allowSort

configurable texts (localization key)

configurableStrings?: DatahubConfigurableStrings

Property Value

Inherited From DatahubCompactViewConfig.configurableStrings

connectionSupportedTypes?: string[]

Property Value

Inherited From DatahubCompactViewConfig.connectionSupportedTypes

The minimal item permission to show per item type.

controlPlaneSupportedTypesPermissions?: {[key: string]: Permissions}

Property Value

Inherited From DatahubCompactViewConfig.controlPlaneSupportedTypesPermissions

Configurable css colors. The key is a datahub style property (SupportedDatahubStyleProperties) or general PowerBI style property (ControlTokens). SupportedDatahubStyleProperties will be applied in case both the datahub property and the control token for that element are configured.

cssStyles?: Partial<Record<DatahubStyleProperties, string>>

Property Value

Inherited From DatahubCompactViewConfig.cssStyles

Context menu configuration for items

customContextMenuConfig?: ContextMenuActionsDefinitions

Property Value

Inherited From DatahubCompactViewConfig.customContextMenuConfig

Where the Datahub is hosted

datahubTableHost?: string

Property Value

Inherited From DatahubCompactViewConfig.datahubTableHost

Additional inforamation content. Will appear only if learnMorelink is defined.

dialogAdditionalInfo?: string

Property Value

Inherited From DatahubHeaderDialogConfig.dialogAdditionalInfo

The title of the dialog

dialogDescription?: string

Property Value

Inherited From DatahubHeaderDialogConfig.dialogDescription

The title of the dialog (localization key)

dialogDescriptionLocalized?: string

Property Value

Inherited From DatahubHeaderDialogConfig.dialogDescriptionLocalized

The title of the dialog

dialogTitle?: string

Property Value

Inherited From DatahubHeaderDialogConfig.dialogTitle

The localized title of the dialog (localization key)

dialogTitleLocalized?: string

Property Value

Inherited From DatahubHeaderDialogConfig.dialogTitleLocalized

Disabling the add data button on empty state screen.

disableAddDataEmptyStateButton?: boolean

Property Value

Inherited From DatahubCompactViewConfig.disableAddDataEmptyStateButton

Whether to disable horizontal scroll – default is 'false'.

disableHorizontalScroll?: boolean

Property Value

Inherited From DatahubCompactViewConfig.disableHorizontalScroll

disableHoverCard?: boolean

Property Value

Inherited From DatahubCompactViewConfig.disableHoverCard

The columns we allow in the table - optional with default value.

displayColumns?: DisplayColumn[]

Property Value

Inherited From DatahubCompactViewConfig.displayColumns

Whether Parent-child relationship is enabled

enableParentChild?: boolean

Property Value

Inherited From DatahubCompactViewConfig.enableParentChild

Whether to enable resize column options. default is 'false'. Users who struggle with performing dragging movements can easily operate an interface with a pointer interface. This feature does not yet support theming and dark mode.

enableResizeColumnOptions?: boolean

Property Value

Inherited From DatahubCompactViewConfig.enableResizeColumnOptions

Will open the datahub compact view filter by the values in the array

filterDatahubByTypes?: string[]

Property Value

Inherited From DatahubCompactViewConfig.filterDatahubByTypes

Filter by list of workspaces/domains – default is no filter

filters?: DatahubFilter[]

Property Value

Inherited From DatahubCompactViewConfig.filters

general connections config, used to set filters for all the supported connection types.

generalConnectionsConfig?: GeneralConnectionsConfig

Property Value

Inherited From DatahubCompactViewConfig.generalConnectionsConfig

Global config for all supported types

globalConfigForAllSupportedTypes?: TypeConfig

Property Value

Inherited From DatahubCompactViewConfig.globalConfigForAllSupportedTypes

The minimal item permission to show.

globalControlPlanePermissionsMask?: Permissions

Property Value

Inherited From DatahubCompactViewConfig.globalControlPlanePermissionsMask

The minimal item permission to show.

globalPermissionsMask?: number

Property Value

Inherited From DatahubCompactViewConfig.globalPermissionsMask

Whether to show the full screen button - default is false

hideFullScreen?: boolean

Property Value

Inherited From DatahubHeaderDialogConfig.hideFullScreen

whether to color the row on selection.

highlightRowOnSelection?: boolean

Property Value

Inherited From DatahubCompactViewConfig.highlightRowOnSelection

Some details on the datahub consumer host.

hostDetails?: HostDetails

Property Value

Inherited From DatahubCompactViewConfig.hostDetails

Hover card configuration

hoverCardConfiguration?: HoverCardConfiguration

Property Value

Inherited From DatahubCompactViewConfig.hoverCardConfiguration

An array of datahub items to be added to the compact view table.

injectedDatahubItemUIs?: InjectedDatahubItemUI[]

Property Value

Inherited From DatahubCompactViewConfig.injectedDatahubItemUIs

Whether is compact view mode

isCompactViewMode?: boolean

Property Value

Inherited From DatahubCompactViewConfig.isCompactViewMode

Whether to show domain selection box – default is 'true'.

isDomainsSelectionEnabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.isDomainsSelectionEnabled

Whether to show fabric icons

isFabricIcons?: boolean

Property Value

Inherited From DatahubCompactViewConfig.isFabricIcons

Whether to show tag filter group in filter - default is 'true'.

isTagFilterEnabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.isTagFilterEnabled

optional - tooltip position for the item icon in the table list. Default is 'before'.

itemIconTooltipPosition?: "above" | "below" | "before" | "after"

Property Value

Inherited From DatahubCompactViewConfig.itemIconTooltipPosition

prevent user from selecting top-level items when this flag is true - by default the value is 'false'

itemSelectionDisabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.itemSelectionDisabled

The default behavior is that learn more link is not visible, until the host customize it.

learnMorelink?: { linkText: string, linkUrl: string }

Property Value

Inherited From DatahubHeaderDialogConfig.learnMorelink

Multi-selection of items is possible when this flag is enabled - by default the value is 'false'.

multiSelectionEnabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.multiSelectionEnabled

selection of parent item is not possible when this flag is true - by default the value is 'false'.

parentSelectionDisabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.parentSelectionDisabled

Search in the compact view results – default is empty string.

searchQueryInput?: string

Property Value

Inherited From DatahubCompactViewConfig.searchQueryInput

Whether to ignore current filters on search – default is 'false'.

searchWithoutPivots?: boolean

Property Value

Inherited From DatahubCompactViewConfig.searchWithoutPivots

The object Id's of the selected datahub items

selectedDatahubItemObjectIds?: string[]

Property Value

Inherited From DatahubCompactViewConfig.selectedDatahubItemObjectIds

Filter by pivot – default is All

selectedPivot?: DatahubListPivot

Property Value

Inherited From DatahubCompactViewConfig.selectedPivot

Whether to mark with bold style search query on the results – default is 'true'. If both this and shouldHighlightSearchQuery are true, the search result will be bold

shouldBoldSearchQuery?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldBoldSearchQuery

Whether to show items in the CV with no scrolling, only what fits to the CV window - default is 'false'.

shouldFitItemsToHeight?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldFitItemsToHeight

Whether to hide empty search result – default is 'false'.

shouldHideEmptySearchResult?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldHideEmptySearchResult

Whether to hide the filter or not – default is 'false'.

shouldHideFilter?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldHideFilter

Whether to hide the pivots or not – default is 'false'.

shouldHideHeader?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldHideHeader

Whether to hide the search box or not – default is 'false'.

shouldHideSearchBox?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldHideSearchBox

Whether to mark with background search query on the results – default is 'false'. If both this and shouldBoldSearchQuery are true, the search result will be bold

shouldHighlightSearchQuery?: boolean

Property Value

Inherited From DatahubCompactViewConfig.shouldHighlightSearchQuery

The function gets the 'item' as input and defines whether to display the item in the table or not.

shouldIncludeFuncByItemType?: {}

Property Value

Inherited From DatahubCompactViewConfig.shouldIncludeFuncByItemType

whether the refresh icon should be shown.

showRefreshIconContainer?: boolean

Property Value

Inherited From DatahubCompactViewConfig.showRefreshIconContainer

only allow user to select a sub-item when this flag is true - by default the value is 'false'. Sub-items will be returned with their parent item.

subItemSelectionEnabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.subItemSelectionEnabled

The connection types to show in the table with their filters. If the key is Connection, it is generally for all connection types.

supportedConnections?: {[key: string]: SupportedConnection}

Property Value

Inherited From DatahubCompactViewConfig.supportedConnections

Which tabs to show on the header - optional with a default value.

supportedPivots?: DatahubListPivot[]

Property Value

Inherited From DatahubCompactViewConfig.supportedPivots

The item types to show in the table

supportedTypes?: string[]

Property Value

Inherited From DatahubCompactViewConfig.supportedTypes

Config for supported type

supportedTypesConfig?: {[key: string]: TypeConfig}

Property Value

Inherited From DatahubCompactViewConfig.supportedTypesConfig

The minimal item permission to show per item.

supportedTypesPermissions?: {[key: string]: number}

Property Value

Inherited From DatahubCompactViewConfig.supportedTypesPermissions

supportHorizontalScroll?: boolean

Property Value

Inherited From DatahubCompactViewConfig.supportHorizontalScroll

whether the action for navigating to the item should be shown.

supportNameDirectLink?: boolean

Property Value

Inherited From DatahubCompactViewConfig.supportNameDirectLink

telemetryAdditionalData?: TelemetryAdditionalData

Property Value

Inherited From DatahubCompactViewConfig.telemetryAdditionalData

Whether to persist open/closed mode of workspace navigation pane from user's local storage – default is 'false'.

useLocalStorageForWorkspaceMode?: boolean

Property Value

Inherited From DatahubCompactViewConfig.useLocalStorageForWorkspaceMode

Whether to show workspace navigation pane – default is 'true'.

workspaceNavigationEnabled?: boolean

Property Value

Inherited From DatahubCompactViewConfig.workspaceNavigationEnabled