acmeportal / treeView/treeDataProvider / FlowTreeDataProvider
Class: FlowTreeDataProvider¶
Defined in: treeView/treeDataProvider.ts:18
Implements¶
TreeDataProvider\<BaseTreeItem>
Constructors¶
Constructor¶
new FlowTreeDataProvider():
FlowTreeDataProvider
Defined in: treeView/treeDataProvider.ts:35
Returns¶
FlowTreeDataProvider
Properties¶
onDidChangeTreeData¶
readonlyonDidChangeTreeData:Event\<undefined|null|void|BaseTreeItem>
Defined in: treeView/treeDataProvider.ts:20
An optional event to signal that an element or root has changed.
This will trigger the view to update the changed element/root and its children recursively (if shown).
To signal that root has changed, do not pass any argument or pass undefined or null.
Implementation of¶
vscode.TreeDataProvider.onDidChangeTreeData
Methods¶
loadFlows()¶
loadFlows():
Promise\<void>
Defined in: treeView/treeDataProvider.ts:47
Load flows from Python files and deployment info from Prefect
Returns¶
Promise\<void>
refresh()¶
refresh():
void
Defined in: treeView/treeDataProvider.ts:359
Returns¶
void
getTreeItem()¶
getTreeItem(
element):TreeItem
Defined in: treeView/treeDataProvider.ts:363
Get TreeItem representation of the element
Parameters¶
element¶
The element for which TreeItem representation is asked for.
Returns¶
TreeItem
TreeItem representation of the element.
Implementation of¶
vscode.TreeDataProvider.getTreeItem
getChildren()¶
getChildren(
element?):Thenable\<BaseTreeItem[]>
Defined in: treeView/treeDataProvider.ts:373
Get the children of element or root if no element is passed.
Parameters¶
element?¶
The element from which the provider gets children. Can be undefined.
Returns¶
Thenable\<BaseTreeItem[]>
Children of element or root if no element is passed.
Implementation of¶
vscode.TreeDataProvider.getChildren
getParent()¶
getParent(
element):ProviderResult\<BaseTreeItem>
Defined in: treeView/treeDataProvider.ts:390
Optional method to return the parent of element.
Return null or undefined if element is a child of root.
NOTE: This method should be implemented in order to access TreeView.reveal reveal API.
Parameters¶
element¶
The element for which the parent has to be returned.
Returns¶
ProviderResult\<BaseTreeItem>
Parent of element.
Implementation of¶
vscode.TreeDataProvider.getParent
applySearch()¶
applySearch(
criteria):void
Defined in: treeView/treeDataProvider.ts:409
Apply search criteria to filter flows and deployments
Parameters¶
criteria¶
Array of search criteria
Returns¶
void
clearSearch()¶
clearSearch():
void
Defined in: treeView/treeDataProvider.ts:433
Clear search and show all items
Returns¶
void
isSearchActive()¶
isSearchActive():
boolean
Defined in: treeView/treeDataProvider.ts:444
Check if search is currently active
Returns¶
boolean
getFilteredItemsCount()¶
getFilteredItemsCount():
object
Defined in: treeView/treeDataProvider.ts:451
Get count of filtered items
Returns¶
object
flows¶
flows:
number
deployments¶
deployments:
number
getSearchCriteria()¶
getSearchCriteria():
SearchCriteria[]
Defined in: treeView/treeDataProvider.ts:467
Get current search criteria