Class UI

The API UI Class. An instance is available via the global API.v1.ui variable.

Index

Methods

hideNavigation navigateToCase navigateToPage resizeToFit showNavigation

Methods

hideNavigation

hideNavigation(): void
Hide the main navigation

Returns void
Example
```
API.v1.ui.hideNavigation();
```

navigateToCase

navigateToCase(caseId: string, view?: string, doNotRedirect?: boolean): void
Navigate to a case, optionally to a specific view case
Parameters
- caseId: string
- Optionalview: string
- doNotRedirect: boolean = false
Returns void
Example
```
API.v1.ui.navigateToCase('1:142:26');
API.v1.ui.navigateToCase('1:4584:27', '1:4581:1322');
```

navigateToPage

navigateToPage(alias: string, view?: string): void
Navigate to a page
Parameters
- alias: string
- Optionalview: string
Returns void
Example
```
API.v1.ui.navigateToPage('homepage');
```

resizeToFit

resizeToFit(): void

Resize the iFrame to fit the content

Returns void

Example

//== Change something in the DOM
$('.somediv').height(542);
//== Trigger iFrame to resize to new size
API.v1.ui.resizeToFit();

showNavigation

showNavigation(): void
Show the main navigation

Returns void
Example
```
API.v1.ui.showNavigation();
```