DatahubCompactViewConfig interface

Package:

@ms-fabric/workload-client

An interface representing a configuration of the Datahub Compact View

Extends

DatahubCompactViewGlobalConfig,DatahubCompactViewDataConfig,DatahubCompactViewTableConfig,DatahubCompactViewTypesConfig,DatahubCompactViewFeaturesConfig,DatahubCompactViewHeaderConfig,DatahubCompactViewFiltersConfig,DatahubCompactViewSearchConfig,DatahubCompactViewSelectionConfig,DatahubCompactViewStringsConfig,DatahubCompactViewHoverCardConfig,DatahubCompactViewTelemetryConfig,DatahubCompactViewStyleConfig,DatahubCompactViewWorkspaceConfig

Inherited Properties

activeSelectedItemObjectIds	The object Id's of the active selected items.
activeTypes	The selected item types to show in the table, subset of supportedTypes
allowSort	whether to allow sort option – default is 'true'.
configurableStrings	configurable texts (localization key)
connectionSupportedTypes
cssStyles	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.
datahubTableHost	Where the Datahub is hosted
disableAddDataEmptyStateButton	Disabling the add data button on empty state screen.
disableHorizontalScroll	Whether to disable horizontal scroll – default is 'false'.
disableHoverCard
displayColumns	The columns we allow in the table - optional with default value.
enableParentChild	Whether Parent-child relationship is enabled
enableResizeColumnOptions	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.
filterDatahubByTypes	Will open the datahub compact view filter by the values in the array
filters	Filter by list of workspaces/domains – default is no filter
globalConfigForAllSupportedTypes	Global config for all supported types
globalPermissionsMask	The minimal item permission to show.
highlightRowOnSelection	whether to color the row on selection.
hostDetails	Some details on the datahub consumer host.
hoverCardConfiguration	Hover card configuration
injectedDatahubItemUIs	An array of datahub items to be added to the compact view table.
isCompactViewMode	Whether is compact view mode
isDomainsSelectionEnabled	Whether to show domain selection box – default is 'true'.
isFabricIcons	Whether to show fabric icons
itemIconTooltipPosition	optional - tooltip position for the item icon in the table list. Default is 'before'.
multiSelectionEnabled	Multi-selection of items is possible when this flag is enabled - by default the value is 'false'.
parentSelectionDisabled	selection of parent item is not possible when this flag is true - by default the value is 'false'.
searchQueryInput	Search in the compact view results – default is empty string.
searchWithoutPivots	Whether to ignore current filters on search – default is 'false'.
selectedDatahubItemObjectIds	The object Id's of the selected datahub items
selectedPivot	Filter by pivot – default is All
shouldBoldSearchQuery	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
shouldFitItemsToHeight	Whether to show items in the CV with no scrolling, only what fits to the CV window - default is 'false'.
shouldHideEmptySearchResult	Whether to hide empty search result – default is 'false'.
shouldHideFilter	Whether to hide the filter or not – default is 'false'.
shouldHideHeader	Whether to hide the pivots or not – default is 'false'.
shouldHideSearchBox	Whether to hide the search box or not – default is 'false'.
shouldHighlightSearchQuery	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
shouldIncludeFuncByItemType	The function gets the 'item' as input and defines whether to display the item in the table or not.
showRefreshIconContainer	whether the refresh icon should be shown.
supportedConnections	The connection types to show in the table with their filters. If the key is Connection, it is generally for all connection types.
supportedPivots	Which tabs to show on the header - optional with a default value.
supportedTypes	The item types to show in the table
supportedTypesConfig	Config for supported type
supportedTypesPermissions	The minimal item permission to show per item.
supportHorizontalScroll
supportNameDirectLink	whether the action for navigating to the item should be shown.
telemetryAdditionalData
useLocalStorageForWorkspaceMode	Whether to persist open/closed mode of workspace navigation pane from user's local storage – default is 'false'.
workspaceNavigationEnabled	Whether to show workspace navigation pane – default is 'true'.

Inherited Property Details

activeSelectedItemObjectIds

The object Id's of the active selected items.

activeSelectedItemObjectIds?: string[]

Property Value

string[]

Inherited From DatahubCompactViewSelectionConfig.activeSelectedItemObjectIds

activeTypes

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

activeTypes?: string[]

Property Value

string[]

Inherited From DatahubCompactViewFiltersConfig.activeTypes

allowSort

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

allowSort?: boolean

Property Value

boolean

Inherited From DatahubCompactViewTableConfig.allowSort

configurableStrings

configurable texts (localization key)

configurableStrings?: DatahubConfigurableStrings

Property Value

DatahubConfigurableStrings

Inherited From DatahubCompactViewStringsConfig.configurableStrings

connectionSupportedTypes

Warning

This API is now deprecated.

this field is not in use. please use instead: supportedConnections

connectionSupportedTypes?: string[]

Property Value

string[]

Inherited From DatahubCompactViewTypesConfig.connectionSupportedTypes

cssStyles

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

Partial<Record<DatahubStyleProperties, string>>

Inherited From DatahubCompactViewStyleConfig.cssStyles

datahubTableHost

Where the Datahub is hosted

datahubTableHost?: string

Property Value

string

Inherited From DatahubCompactViewTableConfig.datahubTableHost

disableAddDataEmptyStateButton

Disabling the add data button on empty state screen.

disableAddDataEmptyStateButton?: boolean

Property Value

boolean

Inherited From DatahubCompactViewFeaturesConfig.disableAddDataEmptyStateButton

disableHorizontalScroll

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

disableHorizontalScroll?: boolean

Property Value

boolean

Inherited From DatahubCompactViewTableConfig.disableHorizontalScroll

disableHoverCard

Warning

This API is now deprecated.

this field is not in use.

disableHoverCard?: boolean

Property Value

boolean

Inherited From DatahubCompactViewHoverCardConfig.disableHoverCard

displayColumns

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

displayColumns?: DisplayColumn[]

Property Value

DisplayColumn[]

Inherited From DatahubCompactViewTableConfig.displayColumns

enableParentChild

Whether Parent-child relationship is enabled

enableParentChild?: boolean

Property Value

boolean

Inherited From DatahubCompactViewFeaturesConfig.enableParentChild

enableResizeColumnOptions

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

boolean

Inherited From DatahubCompactViewTableConfig.enableResizeColumnOptions

filterDatahubByTypes

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

filterDatahubByTypes?: string[]

Property Value

string[]

Inherited From DatahubCompactViewFiltersConfig.filterDatahubByTypes

filters

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

filters?: DatahubFilter[]

Property Value

DatahubFilter[]

Inherited From DatahubCompactViewFiltersConfig.filters

globalConfigForAllSupportedTypes

Global config for all supported types

globalConfigForAllSupportedTypes?: TypeConfig

Property Value

TypeConfig

Inherited From DatahubCompactViewTypesConfig.globalConfigForAllSupportedTypes

globalPermissionsMask

The minimal item permission to show.

globalPermissionsMask?: number

Property Value

number

Inherited From DatahubCompactViewFiltersConfig.globalPermissionsMask

highlightRowOnSelection

whether to color the row on selection.

highlightRowOnSelection?: boolean

Property Value

boolean

Inherited From DatahubCompactViewSelectionConfig.highlightRowOnSelection

hostDetails

Some details on the datahub consumer host.

hostDetails?: HostDetails

Property Value

HostDetails

Inherited From DatahubCompactViewGlobalConfig.hostDetails

hoverCardConfiguration

Hover card configuration

hoverCardConfiguration?: HoverCardConfiguration

Property Value

HoverCardConfiguration

Inherited From DatahubCompactViewHoverCardConfig.hoverCardConfiguration

injectedDatahubItemUIs

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

injectedDatahubItemUIs?: InjectedDatahubItemUI[]

Property Value

InjectedDatahubItemUI[]

Inherited From DatahubCompactViewDataConfig.injectedDatahubItemUIs

isCompactViewMode

Whether is compact view mode

isCompactViewMode?: boolean

Property Value

boolean

Inherited From DatahubCompactViewFeaturesConfig.isCompactViewMode

isDomainsSelectionEnabled

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

isDomainsSelectionEnabled?: boolean

Property Value

boolean

Inherited From DatahubCompactViewFiltersConfig.isDomainsSelectionEnabled

isFabricIcons

Whether to show fabric icons

isFabricIcons?: boolean

Property Value

boolean

Inherited From DatahubCompactViewTableConfig.isFabricIcons

itemIconTooltipPosition

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

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

Property Value

"above" | "below" | "before" | "after"

Inherited From DatahubCompactViewTableConfig.itemIconTooltipPosition

multiSelectionEnabled

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

multiSelectionEnabled?: boolean

Property Value

boolean

Inherited From DatahubCompactViewSelectionConfig.multiSelectionEnabled

parentSelectionDisabled

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

parentSelectionDisabled?: boolean

Property Value

boolean

Inherited From DatahubCompactViewSelectionConfig.parentSelectionDisabled

searchQueryInput

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

searchQueryInput?: string

Property Value

string

Inherited From DatahubCompactViewSearchConfig.searchQueryInput

searchWithoutPivots

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

searchWithoutPivots?: boolean

Property Value

boolean

Inherited From DatahubCompactViewSearchConfig.searchWithoutPivots

selectedDatahubItemObjectIds

The object Id's of the selected datahub items

selectedDatahubItemObjectIds?: string[]

Property Value

string[]

Inherited From DatahubCompactViewSelectionConfig.selectedDatahubItemObjectIds

selectedPivot

Filter by pivot – default is All

selectedPivot?: DatahubListPivot

Property Value

DatahubListPivot

Inherited From DatahubCompactViewFiltersConfig.selectedPivot

shouldBoldSearchQuery

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

boolean

Inherited From DatahubCompactViewSearchConfig.shouldBoldSearchQuery

shouldFitItemsToHeight

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

shouldFitItemsToHeight?: boolean

Property Value

boolean

Inherited From DatahubCompactViewTableConfig.shouldFitItemsToHeight

shouldHideEmptySearchResult

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

shouldHideEmptySearchResult?: boolean

Property Value

boolean

Inherited From DatahubCompactViewSearchConfig.shouldHideEmptySearchResult

shouldHideFilter

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

shouldHideFilter?: boolean

Property Value

boolean

Inherited From DatahubCompactViewFiltersConfig.shouldHideFilter

shouldHideHeader

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

shouldHideHeader?: boolean

Property Value

boolean

Inherited From DatahubCompactViewHeaderConfig.shouldHideHeader

shouldHideSearchBox

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

shouldHideSearchBox?: boolean

Property Value

boolean

Inherited From DatahubCompactViewSearchConfig.shouldHideSearchBox

shouldHighlightSearchQuery

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

boolean

Inherited From DatahubCompactViewSearchConfig.shouldHighlightSearchQuery

shouldIncludeFuncByItemType

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

shouldIncludeFuncByItemType?: {}

Property Value

{}

Inherited From DatahubCompactViewTypesConfig.shouldIncludeFuncByItemType

showRefreshIconContainer

whether the refresh icon should be shown.

showRefreshIconContainer?: boolean

Property Value

boolean

Inherited From DatahubCompactViewTableConfig.showRefreshIconContainer

supportedConnections

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

{[key: string]: SupportedConnection}

Inherited From DatahubCompactViewTypesConfig.supportedConnections

supportedPivots

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

supportedPivots?: DatahubListPivot[]

Property Value

DatahubListPivot[]

Inherited From DatahubCompactViewHeaderConfig.supportedPivots

supportedTypes

The item types to show in the table

supportedTypes?: string[]

Property Value

string[]

Inherited From DatahubCompactViewFiltersConfig.supportedTypes

supportedTypesConfig

Config for supported type

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

Property Value

{[key: string]: TypeConfig}

Inherited From DatahubCompactViewTypesConfig.supportedTypesConfig

supportedTypesPermissions

The minimal item permission to show per item.

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

Property Value

{[key: string]: number}

Inherited From DatahubCompactViewFiltersConfig.supportedTypesPermissions

supportHorizontalScroll

Warning

This API is now deprecated.

this field is not in use. please use instead: disableHorizontalScroll

supportHorizontalScroll?: boolean

Property Value

boolean

Inherited From DatahubCompactViewTableConfig.supportHorizontalScroll

supportNameDirectLink

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

supportNameDirectLink?: boolean

Property Value

boolean

Inherited From DatahubCompactViewFeaturesConfig.supportNameDirectLink

telemetryAdditionalData

Warning

This API is now deprecated.

Please do not use, this interface will not be maintained.

telemetryAdditionalData?: TelemetryAdditionalData

Property Value

TelemetryAdditionalData

Inherited From DatahubCompactViewTelemetryConfig.telemetryAdditionalData

useLocalStorageForWorkspaceMode

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

useLocalStorageForWorkspaceMode?: boolean

Property Value

boolean

Inherited From DatahubCompactViewWorkspaceConfig.useLocalStorageForWorkspaceMode

workspaceNavigationEnabled

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

workspaceNavigationEnabled?: boolean

Property Value

boolean

Inherited From DatahubCompactViewWorkspaceConfig.workspaceNavigationEnabled