DatahubCompactViewConfig interface
An interface representing a configuration of the Datahub Compact View
Properties
allow |
whether to allow sort option – default is 'true'. |
configurable |
configurable texts (localization key) |
connection |
|
css |
Configurable datahub css styles, currently only colors. |
datahub |
Where the Datahub is hosted |
disable |
Disabling the add data button on empty state screen. |
disable |
Whether to disable horizontal scroll – default is 'false'. |
disable |
|
display |
The columns we allow in the table - optional with default value. |
enable |
Whether Parent-child relationship is enabled |
filter |
Will open the datahub compact view filter by the values in the array |
filters | Filter by list of workspaces/domains – default is no filter |
global |
Global config for all supported types |
global |
The minimal item permission to show. |
highlight |
whether to color the row on selection. |
host |
Some details on the datahub consumer host. |
hover |
Hover card configuration |
injected |
An array of datahub items to be added to the compact view table. |
is |
Whether is compact view mode |
is |
Whether to show domain selection box – default is 'true'. |
is |
Whether to show fabric icons |
multi |
Multi-selection of items is possible when this flag is enabled - by default the value is 'false'. |
search |
Search in the compact view results – default is empty string. |
search |
Whether to ignore current filters on search – default is 'false'. |
selected |
The object Id's of the selected datahub items |
selected |
Filter by pivot – default is All |
should |
Whether to mark with bold style search query on the results – default is 'true'.
If both this and |
should |
Whether to show items in the CV with no scrolling, only what fits to the CV window - default is 'false'. |
should |
Whether to hide empty search result – default is 'false'. |
should |
Whether to hide the filter or not – default is 'false'. |
should |
Whether to hide the pivots or not – default is 'false'. |
should |
Whether to hide the search box or not – default is 'false'. |
should |
Whether to mark with background search query on the results – default is 'false'.
If both this and |
should |
The function gets the 'item' as input and defines whether to display the item in the table or not. |
supported |
The connection types to show in the table with there filters |
supported |
Which tabs to show on the header - optional with a default value. |
supported |
The item types to show in the table |
supported |
Config for supported type |
supported |
The minimal item permission to show per item. |
support |
|
support |
whether the action for navigating to the item should be shown. |
use |
Whether to persist open/closed mode of workspace navigation pane from user's local storage – default is 'false'. |
workspace |
Whether to show workspace navigation pane – default is 'true'. |
Property Details
allowSort
whether to allow sort option – default is 'true'.
allowSort?: boolean
Property Value
boolean
configurableStrings
configurable texts (localization key)
configurableStrings?: DatahubConfigurableStrings
Property Value
connectionSupportedTypes
Warning
This API is now deprecated.
this field is not in use. please use instead: supportedConnections
connectionSupportedTypes?: string[]
Property Value
string[]
cssStyles
Configurable datahub css styles, currently only colors.
cssStyles?: Partial<Record<SupportedDatahubStyleProperties, string>>
Property Value
Partial<Record<SupportedDatahubStyleProperties, string>>
datahubTableHost
Where the Datahub is hosted
datahubTableHost?: string
Property Value
string
disableAddDataEmptyStateButton
Disabling the add data button on empty state screen.
disableAddDataEmptyStateButton?: boolean
Property Value
boolean
disableHorizontalScroll
Whether to disable horizontal scroll – default is 'false'.
disableHorizontalScroll?: boolean
Property Value
boolean
disableHoverCard
Warning
This API is now deprecated.
this field is not in use.
disableHoverCard?: boolean
Property Value
boolean
displayColumns
The columns we allow in the table - optional with default value.
displayColumns?: DisplayColumn[]
Property Value
enableParentChild
Whether Parent-child relationship is enabled
enableParentChild?: boolean
Property Value
boolean
filterDatahubByTypes
Will open the datahub compact view filter by the values in the array
filterDatahubByTypes?: string[]
Property Value
string[]
filters
Filter by list of workspaces/domains – default is no filter
filters?: DatahubFilter[]
Property Value
globalConfigForAllSupportedTypes
Global config for all supported types
globalConfigForAllSupportedTypes?: TypeConfig
Property Value
globalPermissionsMask
The minimal item permission to show.
globalPermissionsMask?: number
Property Value
number
highlightRowOnSelection
whether to color the row on selection.
highlightRowOnSelection?: boolean
Property Value
boolean
hostDetails
hoverCardConfiguration
Hover card configuration
hoverCardConfiguration?: HoverCardConfiguration
Property Value
injectedDatahubItemUIs
An array of datahub items to be added to the compact view table.
injectedDatahubItemUIs?: InjectedDatahubItemUI[]
Property Value
isCompactViewMode
Whether is compact view mode
isCompactViewMode?: boolean
Property Value
boolean
isDomainsSelectionEnabled
Whether to show domain selection box – default is 'true'.
isDomainsSelectionEnabled?: boolean
Property Value
boolean
isFabricIcons
Whether to show fabric icons
isFabricIcons?: boolean
Property Value
boolean
multiSelectionEnabled
Multi-selection of items is possible when this flag is enabled - by default the value is 'false'.
multiSelectionEnabled?: boolean
Property Value
boolean
searchQueryInput
Search in the compact view results – default is empty string.
searchQueryInput?: string
Property Value
string
searchWithoutPivots
Whether to ignore current filters on search – default is 'false'.
searchWithoutPivots?: boolean
Property Value
boolean
selectedDatahubItemObjectIds
The object Id's of the selected datahub items
selectedDatahubItemObjectIds?: string[]
Property Value
string[]
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
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
shouldHideEmptySearchResult
Whether to hide empty search result – default is 'false'.
shouldHideEmptySearchResult?: boolean
Property Value
boolean
shouldHideFilter
Whether to hide the filter or not – default is 'false'.
shouldHideFilter?: boolean
Property Value
boolean
shouldHideHeader
Whether to hide the pivots or not – default is 'false'.
shouldHideHeader?: boolean
Property Value
boolean
shouldHideSearchBox
Whether to hide the search box or not – default is 'false'.
shouldHideSearchBox?: boolean
Property Value
boolean
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
shouldIncludeFuncByItemType
The function gets the 'item' as input and defines whether to display the item in the table or not.
shouldIncludeFuncByItemType?: {}
Property Value
{}
supportedConnections
The connection types to show in the table with there filters
supportedConnections?: {[key: string]: SupportedConnection}
Property Value
{[key: string]: SupportedConnection}
supportedPivots
Which tabs to show on the header - optional with a default value.
supportedPivots?: DatahubListPivot[]
Property Value
supportedTypes
The item types to show in the table
supportedTypes?: string[]
Property Value
string[]
supportedTypesConfig
Config for supported type
supportedTypesConfig?: {[key: string]: TypeConfig}
Property Value
{[key: string]: TypeConfig}
supportedTypesPermissions
The minimal item permission to show per item.
supportedTypesPermissions?: {[key: string]: number}
Property Value
{[key: string]: number}
supportHorizontalScroll
Warning
This API is now deprecated.
this field is not in use. please use instead: disableHorizontalScroll
supportHorizontalScroll?: boolean
Property Value
boolean
supportNameDirectLink
whether the action for navigating to the item should be shown.
supportNameDirectLink?: boolean
Property Value
boolean
useLocalStorageForWorkspaceMode
Whether to persist open/closed mode of workspace navigation pane from user's local storage – default is 'false'.
useLocalStorageForWorkspaceMode?: boolean
Property Value
boolean
workspaceNavigationEnabled
Whether to show workspace navigation pane – default is 'true'.
workspaceNavigationEnabled?: boolean
Property Value
boolean