Class Index | File Index

Classes


Namespace LABKEY.NavTrail

NavTrail static class to adjust the text in LabKey's navigation trail. The navigation trail is the list of links across the top of the main body area, as well as the title for the current page.
Defined in: NavTrail.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
LABKEY.NavTrail.setTrail(currentPageTitle, ancestors, documentTitle, encode, removeFolderLink)
Set the nav trail's elements.
Namespace Detail
LABKEY.NavTrail
Method Detail
<static> LABKEY.NavTrail.setTrail(currentPageTitle, ancestors, documentTitle, encode, removeFolderLink)
Set the nav trail's elements.
var ancestorURL = LABKEY.ActionURL.buildURL('project', 'begin');
LABKEY.NavTrail.setTrail("People View", [{url: ancestorURL, title: "API Example"}]);
Parameters:
{string} currentPageTitle
The title for the current page
{Object[]} ancestors Optional
An array of objects that describe the ancestor pages. Each object in this array can have two properties: url (which contains the URL for the page); and title (which contains the title for the page). These will be assembled into the full list of ancestor pages at the top of the nav trail.
{string} documentTitle Optional
Document title
{boolean} encode Optional, Default: true
HTML encode the contents of currentPageTitle. Can be set to false if you are looking to include html.
{boolean} removeFolderLink Optional, Default: false
Remove any folder navigation links that are showing after the nav trail

Documentation generated by JsDoc Toolkit 2.3.2 on Tue Sep 11 2018 10:10:59 GMT-0000 (UTC)