OnelakeExplorerConfig interface

Package:

@ms-fabric/workload-client

An interface representing the configuration of the OneLake explorer

Properties

applySchemaDiscovery	the SchemaDiscovery for the Onelake explorer - display schema and table icons
applyTableDiscovery	the TableDiscovery for the Onelake explorer - display table icon
areRootNodesCheckable	Whether to select Files or Tables - default is 'true'
autoSelectChildNode	autoSelectChildNode enables selection of child node on parent node checked
checkMode	the CheckMode for the Onelake explorer - none / single (Radio button) / multi select (Checkbox)
disableExternalShortcuts	disable only external shortcuts in browse
disableInternalShortcuts	disable only internal shortcuts in browse
disableShortcuts	disable all shortcuts in browse
expansionLevel	expansionLevel decides to provide expansion upto N levels
folderTooltipMessage	disabled tooltip message for folders
includeTitleIcon	Whether to show Onelake icon - default is 'true'
localizedContentTitle	Localized content title
multiSelectThreshold	maximum number of items that can be selected simultaneously
multiSelectThresholdError	error message displayed when the number of selected items exceeds the allowed threshold
onelakeExplorerTypes	Onelake explorer types
onelakeItem	Onelake explorer item
selectedTreeItems	pre selected tree items
showFilesFolder	show files and folder for explorer dialog. - default is 'false'
skipBrowseNodeDisable	the skip node diable feature based on SchemaDiscovery or TableDiscovery
tableTooltipMessage	disabled tooltip message for tables

Property Details

applySchemaDiscovery

the SchemaDiscovery for the Onelake explorer - display schema and table icons

applySchemaDiscovery?: boolean

Property Value

boolean

applyTableDiscovery

the TableDiscovery for the Onelake explorer - display table icon

applyTableDiscovery?: boolean

Property Value

boolean

areRootNodesCheckable

Whether to select Files or Tables - default is 'true'

areRootNodesCheckable?: boolean

Property Value

boolean

autoSelectChildNode

autoSelectChildNode enables selection of child node on parent node checked

autoSelectChildNode?: boolean

Property Value

boolean

checkMode

the CheckMode for the Onelake explorer - none / single (Radio button) / multi select (Checkbox)

checkMode?: OnelakeExplorerCheckMode

Property Value

OnelakeExplorerCheckMode

disableExternalShortcuts

disable only external shortcuts in browse

disableExternalShortcuts?: boolean

Property Value

boolean

disableInternalShortcuts

disable only internal shortcuts in browse

disableInternalShortcuts?: boolean

Property Value

boolean

disableShortcuts

disable all shortcuts in browse

disableShortcuts?: boolean

Property Value

boolean

expansionLevel

expansionLevel decides to provide expansion upto N levels

expansionLevel?: number

Property Value

number

folderTooltipMessage

disabled tooltip message for folders

folderTooltipMessage?: string

Property Value

string

includeTitleIcon

Whether to show Onelake icon - default is 'true'

includeTitleIcon?: boolean

Property Value

boolean

localizedContentTitle

Localized content title

localizedContentTitle?: string

Property Value

string

multiSelectThreshold

maximum number of items that can be selected simultaneously

multiSelectThreshold?: number

Property Value

number

multiSelectThresholdError

error message displayed when the number of selected items exceeds the allowed threshold

multiSelectThresholdError?: string

Property Value

string

onelakeExplorerTypes

Onelake explorer types

onelakeExplorerTypes?: OnelakeExplorerType[]

Property Value

OnelakeExplorerType[]

onelakeItem

Onelake explorer item

onelakeItem: OnelakeExplorerItem

Property Value

OnelakeExplorerItem

selectedTreeItems

pre selected tree items

selectedTreeItems?: OnelakeExplorerData[]

Property Value

OnelakeExplorerData[]

showFilesFolder

show files and folder for explorer dialog. - default is 'false'

showFilesFolder?: boolean

Property Value

boolean

skipBrowseNodeDisable

the skip node diable feature based on SchemaDiscovery or TableDiscovery

skipBrowseNodeDisable?: boolean

Property Value

boolean

tableTooltipMessage

disabled tooltip message for tables

tableTooltipMessage?: string

Property Value

string