Class: SDKNavigator
SDKNavigator - The platform navigator.
The SDKNavigator class enables navigation to routes within the platform.
Implements
Table of contents
Constructors
Methods
- projects
- projectOverview
- datasets
- datasetBrowser
- projectTeam
- tasks
- taskBrowser
- assignments
- cloudStorage
- applicationHub
- orgMembersAndGroups
- auditLogs
- studio
- recipes
- recipe
- custom
- startline
Constructors
constructor
• new SDKNavigator(agent)
Creates an instance of Navigator.
Parameters
| Name | Type |
|---|---|
agent | PeerAgent |
Methods
projects
▸ projects(options?): void
Navigates to the projects page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
projectOverview
▸ projectOverview(options?): void
Navigates to the project overview page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
datasets
▸ datasets(options?): void
Navigates to the datasets page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
datasetBrowser
▸ datasetBrowser(datasetId, options?): void
Navigates to the dataset browser page.
Parameters
| Name | Type | Description |
|---|---|---|
datasetId | string | The id of the dataset to navigate to. |
options? | DlNavigationOptions | The navigation options. |
Returns
void
projectTeam
▸ projectTeam(options?): void
Navigates to the active project's team page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
tasks
▸ tasks(options?): void
Navigates to the active project's tasks page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
taskBrowser
▸ taskBrowser(taskId, options?): void
Navigates to the active project's task browser page.
Parameters
| Name | Type | Description |
|---|---|---|
taskId | string | The id of the task to navigate to. |
options? | DlNavigationOptions | The navigation options. |
Returns
void
assignments
▸ assignments(options?): void
Navigates to the active project's assignments page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
cloudStorage
▸ cloudStorage(options?): void
Navigates to the active project's cloud storage page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
applicationHub
▸ applicationHub(options?): void
Navigates to the application hub page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
orgMembersAndGroups
▸ orgMembersAndGroups(options?): void
Navigates to the active organization's members and groups page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
auditLogs
▸ auditLogs(options?): void
Navigates to the active organization's audit logs page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
studio
▸ studio(params, options?): void
Navigates to the active project's dataset item page (the studio).
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The navigation params. |
params.datasetId? | string | The id of the dataset the item belongs to. When not provided, the active dataset is used. |
params.itemId | string | The id of the item to navigate to. |
options? | DlNavigationOptions | The navigation options. |
Returns
void
recipes
▸ recipes(options?): void
Navigates to the active project's recipes page.
Parameters
| Name | Type | Description |
|---|---|---|
options? | DlNavigationOptions | The navigation options. |
Returns
void
recipe
▸ recipe(recipeId, options?): void
Navigates to the active project's recipe page.
Parameters
| Name | Type | Description |
|---|---|---|
recipeId | string | The id of the recipe to navigate to. |
options? | DlNavigationOptions | The navigation options. |
Returns
void
custom
▸ custom(route, payload?): void
Navigates to a custom route.
Parameters
| Name | Type | Description |
|---|---|---|
route | string | The route to navigate to. |
payload? | Object | The navigation payload. |
payload.params? | any | The navigation params. |
payload.options? | DlNavigationOptions | The navigation options. |
Returns
void
startline
▸ startline(payload): void
Navigates to the startline page.
Example
dl.navigator.startline({ query: { tab: "Models" }, options: { newTab: true } })Parameters
| Name | Type | Description |
|---|---|---|
payload | Object | - |
payload.query? | Dictionary | The query parameters. For example: { tab: "Models" } |
payload.options? | DlNavigationOptions | The navigation options. For example: { newTab: true } |
Returns
void