Interface NavUtils

Contains utilities for navigation in the main window. It also exists in dialogs and other sub-windows, but in dialogs and sub-windows, it is just a reference to the navUtils instance in the main window. Instance variable: navUtils

interface NavUtils {
    createNodeState: ((handlerID, dataSource?) => any);
    filePath2nodePath: ((filePath) => any[]);
    getActiveCollection: (() => Collection);
    getActiveNode: (() => SharedNode);
    getActiveTabQueryData: (() => QueryData);
    getActiveView: (() => ViewData);
    getActiveViewHandler: (() => ViewHandler);
    getActiveViewPanel: (() => any);
    getFocusedFolder: (() => Promise<string>);
    getFocusedNode: (() => SharedNode);
    getNodeFolder: ((node) => Promise<string>);
    getOutOfActiveView: ((nav2Node?) => void);
    getTrackCollectionAsync: ((track) => Promise<Collection>);
    isCollectionRootNodeActive: (() => boolean);
    navigateNodePath: ((nodePathSources, resolveWhenFinished?) => Promise<void>);
    navigateObject: ((params) => any);
}

Properties

createNodeState filePath2nodePath getActiveCollection getActiveNode getActiveTabQueryData getActiveView getActiveViewHandler getActiveViewPanel getFocusedFolder getFocusedNode getNodeFolder getOutOfActiveView getTrackCollectionAsync isCollectionRootNodeActive navigateNodePath navigateObject

Properties

createNodeState

createNodeState: ((handlerID, dataSource?) => any)

Type declaration

    • (handlerID, dataSource?): any

    • Parameters

      • handlerID: string
      • Optional dataSource: any

      Returns any

Undocumented

filePath2nodePath

filePath2nodePath: ((filePath) => any[])

Type declaration

    • (filePath): any[]

    • Parameters

      • filePath: string

      Returns any[]

Undocumented

getActiveCollection

getActiveCollection: (() => Collection)

Type declaration

Undocumented

getActiveNode

getActiveNode: (() => SharedNode)

Type declaration

Undocumented

getActiveTabQueryData

getActiveTabQueryData: (() => QueryData)

Type declaration

Undocumented

getActiveView

getActiveView: (() => ViewData)

Type declaration

Undocumented

getActiveViewHandler

getActiveViewHandler: (() => ViewHandler)

Type declaration

Undocumented

getActiveViewPanel

getActiveViewPanel: (() => any)

Type declaration

    • (): any

    • Returns any

Undocumented

getFocusedFolder

getFocusedFolder: (() => Promise<string>)

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

Undocumented

getFocusedNode

getFocusedNode: (() => SharedNode)

Type declaration

Undocumented

getNodeFolder

getNodeFolder: ((node) => Promise<string>)

Type declaration

    • (node): Promise<string>

    • Parameters

      Returns Promise<string>

Undocumented

getOutOfActiveView

getOutOfActiveView: ((nav2Node?) => void)

Type declaration

    • (nav2Node?): void

    • Parameters

      Returns void

Undocumented

getTrackCollectionAsync

getTrackCollectionAsync: ((track) => Promise<Collection>)

Type declaration

Undocumented

isCollectionRootNodeActive

isCollectionRootNodeActive: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Undocumented

navigateNodePath

navigateNodePath: ((nodePathSources, resolveWhenFinished?) => Promise<void>)

Type declaration

    • (nodePathSources, resolveWhenFinished?): Promise<void>

    • Parameters

      • nodePathSources: any[]
      • Optional resolveWhenFinished: boolean

      Returns Promise<void>

Undocumented

navigateObject

navigateObject: ((params) => any)

Type declaration

    • (params): any

    • Parameters

      Returns any

Undocumented

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc