UNPKG

com.phloxui

Version:

PhloxUI Ng2+ Framework

697 lines 104 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MenuTopLayout | com.phloxui</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">com.phloxui</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_component_menutoplayout_component_.html">&quot;component/MenuTopLayout.component&quot;</a> </li> <li> <a href="_component_menutoplayout_component_.menutoplayout.html">MenuTopLayout</a> </li> </ul> <h1>Class MenuTopLayout</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="_component_abstractnavmenu_.abstractnavmenu.html" class="tsd-signature-type">AbstractNavMenu</a><span class="tsd-signature-symbol">&lt;</span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a><span class="tsd-signature-symbol">&gt;</span> <ul class="tsd-hierarchy"> <li> <span class="target">MenuTopLayout</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel"> <h3>Implements</h3> <ul class="tsd-hierarchy"> <li><a href="../interfaces/_share_ihasoptions_.ihasoptions.html" class="tsd-signature-type">IHasOptions</a></li> <li><a href="../interfaces/_share_ii18napplicable_.ii18napplicable.html" class="tsd-signature-type">II18NApplicable</a></li> <li><a href="../interfaces/_component_inavigator_.inavigator.html" class="tsd-signature-type">INavigator</a><span class="tsd-signature-symbol">&lt;</span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a><span class="tsd-signature-symbol">&gt;</span></li> <li><span class="tsd-signature-type">OnInit</span></li> <li><a href="../interfaces/_component_iapplicationaware_.iapplicationaware.html" class="tsd-signature-type">IApplicationAware</a></li> <li><span class="tsd-signature-type">OnInit</span></li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_component_menutoplayout_component_.menutoplayout.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#bypass" class="tsd-kind-icon">bypass</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#i18nkey" class="tsd-kind-icon">i18n<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#i18nvalue" class="tsd-kind-icon">i18n<wbr>Value</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_menutoplayout_component_.menutoplayout.html#itemmodels" class="tsd-kind-icon">item<wbr>Models</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#items" class="tsd-kind-icon">items</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_menutoplayout_component_.menutoplayout.html#menuitemprovider" class="tsd-kind-icon">menu<wbr>Item<wbr>Provider</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#navigatesubjects" class="tsd-kind-icon">navigate<wbr>Subjects</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#observablemgr" class="tsd-kind-icon">observable<wbr>Mgr</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#options" class="tsd-kind-icon">options</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_menutoplayout_component_.menutoplayout.html#phloxappservice" class="tsd-kind-icon">phlox<wbr>App<wbr>Service</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_component_menutoplayout_component_.menutoplayout.html#subtopicname" class="tsd-kind-icon">sub<wbr>Topic<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_component_menutoplayout_component_.menutoplayout.html#navigate_cmd_topic_name" class="tsd-kind-icon">NAVIGATE_<wbr>CMD_<wbr>TOPIC_<wbr>NAME</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_component_menutoplayout_component_.menutoplayout.html#navigate_topic_name" class="tsd-kind-icon">NAVIGATE_<wbr>TOPIC_<wbr>NAME</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_component_menutoplayout_component_.menutoplayout.html#sub_topic_name" class="tsd-kind-icon">SUB_<wbr>TOPIC_<wbr>NAME</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_component_menutoplayout_component_.menutoplayout.html#type_name" class="tsd-kind-icon">TYPE_<wbr>NAME</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-private"><a href="_component_menutoplayout_component_.menutoplayout.html#app" class="tsd-kind-icon">app</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#additem" class="tsd-kind-icon">add<wbr>Item</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#applyi18n" class="tsd-kind-icon">apply<wbr>I18N</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#containsitem" class="tsd-kind-icon">contains<wbr>Item</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_component_menutoplayout_component_.menutoplayout.html#donavigate" class="tsd-kind-icon">do<wbr>Navigate</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getactiveindex" class="tsd-kind-icon">get<wbr>Active<wbr>Index</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getactiveitem" class="tsd-kind-icon">get<wbr>Active<wbr>Item</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_menutoplayout_component_.menutoplayout.html#getapplication" class="tsd-kind-icon">get<wbr>Application</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#geti18nkey" class="tsd-kind-icon">get<wbr>I18NKey</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#geti18nvalue" class="tsd-kind-icon">get<wbr>I18NValue</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getitembyindex" class="tsd-kind-icon">get<wbr>Item<wbr>ByIndex</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getitembyname" class="tsd-kind-icon">get<wbr>Item<wbr>ByName</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getitemcount" class="tsd-kind-icon">get<wbr>Item<wbr>Count</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getitemindex" class="tsd-kind-icon">get<wbr>Item<wbr>Index</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getitemindexbyname" class="tsd-kind-icon">get<wbr>Item<wbr>Index<wbr>ByName</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getitems" class="tsd-kind-icon">get<wbr>Items</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_menutoplayout_component_.menutoplayout.html#getmenuitems" class="tsd-kind-icon">get<wbr>Menu<wbr>Items</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#getsubtopicname" class="tsd-kind-icon">get<wbr>Sub<wbr>Topic<wbr>Name</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#isbypasskey" class="tsd-kind-icon">is<wbr>Bypass<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#navigateto" class="tsd-kind-icon">navigate<wbr>To</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#navigatetoindex" class="tsd-kind-icon">navigate<wbr>ToIndex</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#navigatetoname" class="tsd-kind-icon">navigate<wbr>ToName</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_component_menutoplayout_component_.menutoplayout.html#ngoninit" class="tsd-kind-icon">ng<wbr>OnInit</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_menutoplayout_component_.menutoplayout.html#reloadmenuitems" class="tsd-kind-icon">reload<wbr>Menu<wbr>Items</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#removeitem" class="tsd-kind-icon">remove<wbr>Item</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#reset" class="tsd-kind-icon">reset</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#setbypasskey" class="tsd-kind-icon">set<wbr>Bypass<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#seti18nkey" class="tsd-kind-icon">set<wbr>I18NKey</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#setitems" class="tsd-kind-icon">set<wbr>Items</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_component_menutoplayout_component_.menutoplayout.html#setoptions" class="tsd-kind-icon">set<wbr>Options</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_component_menutoplayout_component_.menutoplayout.html#getnavigatecmdtopicname" class="tsd-kind-icon">get<wbr>Navigate<wbr>Cmd<wbr>Topic<wbr>Name</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_component_menutoplayout_component_.menutoplayout.html#getnavigatetopicname" class="tsd-kind-icon">get<wbr>Navigate<wbr>Topic<wbr>Name</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>Menu<wbr>Top<wbr>Layout<span class="tsd-signature-symbol">(</span>phloxAppService<span class="tsd-signature-symbol">: </span><a href="_service_phloxappservice_service_.phloxappservice.html" class="tsd-signature-type">PhloxAppService</a>, menuItemProvider<span class="tsd-signature-symbol">: </span><a href="_service_mainmenuitemprovider_service_.mainmenuitemprovider.html" class="tsd-signature-type">MainMenuItemProvider</a>, obsvMgr<span class="tsd-signature-symbol">: </span><a href="_service_observablemanager_service_.observablemanager.html" class="tsd-signature-type">ObservableManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_component_.menutoplayout.html" class="tsd-signature-type">MenuTopLayout</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#constructor">constructor</a></p> <ul> <li>Defined in component/MenuTopLayout.component.ts:42</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>phloxAppService: <a href="_service_phloxappservice_service_.phloxappservice.html" class="tsd-signature-type">PhloxAppService</a></h5> </li> <li> <h5>menuItemProvider: <a href="_service_mainmenuitemprovider_service_.mainmenuitemprovider.html" class="tsd-signature-type">MainMenuItemProvider</a></h5> </li> <li> <h5>obsvMgr: <a href="_service_observablemanager_service_.observablemanager.html" class="tsd-signature-type">ObservableManager</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_component_menutoplayout_component_.menutoplayout.html" class="tsd-signature-type">MenuTopLayout</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a name="bypass" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> bypass</h3> <div class="tsd-signature tsd-kind-icon">bypass<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Overrides <a href="_share_abstracti18napplicable_.abstracti18napplicable.html">AbstractI18NApplicable</a>.<a href="_share_abstracti18napplicable_.abstracti18napplicable.html#bypass">bypass</a></p> <ul> <li>Defined in component/MenuTopLayout.component.ts:31</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a name="i18nkey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> i18n<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">i18n<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Overrides <a href="_share_abstracti18napplicable_.abstracti18napplicable.html">AbstractI18NApplicable</a>.<a href="_share_abstracti18napplicable_.abstracti18napplicable.html#i18nkey">i18nKey</a></p> <ul> <li>Defined in component/MenuTopLayout.component.ts:29</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="i18nvalue" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> i18n<wbr>Value</h3> <div class="tsd-signature tsd-kind-icon">i18n<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_share_abstracti18napplicable_.abstracti18napplicable.html">AbstractI18NApplicable</a>.<a href="_share_abstracti18napplicable_.abstracti18napplicable.html#i18nvalue">i18nValue</a></p> <ul> <li>Defined in share/AbstractI18NApplicable.ts:13</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="itemmodels" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> item<wbr>Models</h3> <div class="tsd-signature tsd-kind-icon">item<wbr>Models<span class="tsd-signature-symbol">:</span> <a href="_component_model_phloxmainmenuitem_.phloxmainmenuitem.html" class="tsd-signature-type">PhloxMainMenuItem</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/MenuTopLayout.component.ts:35</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="items" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> items</h3> <div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#items">items</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:92</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="menuitemprovider" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> menu<wbr>Item<wbr>Provider</h3> <div class="tsd-signature tsd-kind-icon">menu<wbr>Item<wbr>Provider<span class="tsd-signature-symbol">:</span> <a href="_service_mainmenuitemprovider_service_.mainmenuitemprovider.html" class="tsd-signature-type">MainMenuItemProvider</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/MenuTopLayout.component.ts:34</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="navigatesubjects" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> navigate<wbr>Subjects</h3> <div class="tsd-signature tsd-kind-icon">navigate<wbr>Subjects<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#navigatesubjects">navigateSubjects</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:94</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="observablemgr" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> observable<wbr>Mgr</h3> <div class="tsd-signature tsd-kind-icon">observable<wbr>Mgr<span class="tsd-signature-symbol">:</span> <a href="_service_observablemanager_service_.observablemanager.html" class="tsd-signature-type">ObservableManager</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#observablemgr">observableMgr</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:95</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="options" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3> <div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_share_abstracthasoptions_.abstracthasoptions.html">AbstractHasOptions</a>.<a href="_share_abstracthasoptions_.abstracthasoptions.html#options">options</a></p> <ul> <li>Defined in share/AbstractHasOptions.ts:5</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="phloxappservice" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> phlox<wbr>App<wbr>Service</h3> <div class="tsd-signature tsd-kind-icon">phlox<wbr>App<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="_service_phloxappservice_service_.phloxappservice.html" class="tsd-signature-type">PhloxAppService</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/MenuTopLayout.component.ts:33</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="subtopicname" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> sub<wbr>Topic<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">sub<wbr>Topic<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#subtopicname">subTopicName</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:93</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"> <a name="navigate_cmd_topic_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> NAVIGATE_<wbr>CMD_<wbr>TOPIC_<wbr>NAME</h3> <div class="tsd-signature tsd-kind-icon">NAVIGATE_<wbr>CMD_<wbr>TOPIC_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;NAVIGATE_CMD_TOPIC_NAME</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#navigate_cmd_topic_name">NAVIGATE_CMD_TOPIC_NAME</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:38</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"> <a name="navigate_topic_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> NAVIGATE_<wbr>TOPIC_<wbr>NAME</h3> <div class="tsd-signature tsd-kind-icon">NAVIGATE_<wbr>TOPIC_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;NAVIGATE_TOPIC_NAME</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#navigate_topic_name">NAVIGATE_TOPIC_NAME</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:37</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="sub_topic_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SUB_<wbr>TOPIC_<wbr>NAME</h3> <div class="tsd-signature tsd-kind-icon">SUB_<wbr>TOPIC_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;SUB_TOPIC_NAME</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/MenuTopLayout.component.ts:26</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="type_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> TYPE_<wbr>NAME</h3> <div class="tsd-signature tsd-kind-icon">TYPE_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;TYPE_NAME</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/MenuTopLayout.component.ts:24</li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-private"> <a name="app" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> app</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> app<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_phloxapp_component_.phloxapp.html" class="tsd-signature-type">PhloxApp</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/MenuTopLayout.component.ts:37</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_component_phloxapp_component_.phloxapp.html" class="tsd-signature-type">PhloxApp</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="additem" class="tsd-anchor"></a> <h3>add<wbr>Item</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">add<wbr>Item<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#additem">addItem</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:219</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Add a new <code>nav item</code> into this <code>nav menu</code>. If there already is the given <code><b>item</b></code> in this <code>nav menu</code>, this method will do nothing and return <code>false</code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>item: <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></h5> <div class="tsd-comment tsd-typography"> <p>A new <code>nav item</code> to be added into this <code>nav menu</code>.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>Returns <code>true</code> if the given <code><b>item</b></code> is added into this <code>nav menu</code>. Otherwise, returns <code>false</code>.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="applyi18n" class="tsd-anchor"></a> <h3>apply<wbr>I18N</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">apply<wbr>I18N<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_share_ii18napplicable_.ii18napplicable.html">II18NApplicable</a>.<a href="../interfaces/_share_ii18napplicable_.ii18napplicable.html#applyi18n">applyI18N</a></p> <p>Inherited from <a href="_share_abstracti18napplicable_.abstracti18napplicable.html">AbstractI18NApplicable</a>.<a href="_share_abstracti18napplicable_.abstracti18napplicable.html#applyi18n">applyI18N</a></p> <ul> <li>Defined in share/AbstractI18NApplicable.ts:15</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="containsitem" class="tsd-anchor"></a> <h3>contains<wbr>Item</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">contains<wbr>Item<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#containsitem">containsItem</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:269</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> To check that the given <code><b>item</b></code> is in this <code>nav menu</code> or not. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>item: <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></h5> <div class="tsd-comment tsd-typography"> <p>A <code>nav item</code> to check that it is in this <code>nav menu</code> or not.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>Returns <code>true</code> if the given <code><b>item</b></code> is in this <code>nav menu</code>.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="donavigate" class="tsd-anchor"></a> <h3>do<wbr>Navigate</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">do<wbr>Navigate<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#donavigate">doNavigate</a></p> <ul> <li>Defined in component/MenuTopLayout.component.ts:86</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>item: <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getactiveindex" class="tsd-anchor"></a> <h3>get<wbr>Active<wbr>Index</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>Active<wbr>Index<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_component_inavigator_.inavigator.html">INavigator</a>.<a href="../interfaces/_component_inavigator_.inavigator.html#getactiveindex">getActiveIndex</a></p> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#getactiveindex">getActiveIndex</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:173</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get an active <code>nav item</code> index of this <code>nav menu</code>. </p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>Returns <code>-1</code> if there is no current active item. Otherwise, return the array index of current active item.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getactiveitem" class="tsd-anchor"></a> <h3>get<wbr>Active<wbr>Item</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>Active<wbr>Item<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_component_inavigator_.inavigator.html">INavigator</a>.<a href="../interfaces/_component_inavigator_.inavigator.html#getactiveitem">getActiveItem</a></p> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#getactiveitem">getActiveItem</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:190</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get an active <code>nav item</code> of this <code>nav menu</code>. </p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></h4> <p>Returns <code>null</code> if there is no current active item.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getapplication" class="tsd-anchor"></a> <h3>get<wbr>Application</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Application<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_phloxapp_component_.phloxapp.html" class="tsd-signature-type">PhloxApp</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_component_iapplicationaware_.iapplicationaware.html">IApplicationAware</a>.<a href="../interfaces/_component_iapplicationaware_.iapplicationaware.html#getapplication">getApplication</a></p> <ul> <li>Defined in component/MenuTopLayout.component.ts:66</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_component_phloxapp_component_.phloxapp.html" class="tsd-signature-type">PhloxApp</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="geti18nkey" class="tsd-anchor"></a> <h3>get<wbr>I18NKey</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>I18NKey<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_share_ii18napplicable_.ii18napplicable.html">II18NApplicable</a>.<a href="../interfaces/_share_ii18napplicable_.ii18napplicable.html#geti18nkey">getI18NKey</a></p> <p>Inherited from <a href="_share_abstracti18napplicable_.abstracti18napplicable.html">AbstractI18NApplicable</a>.<a href="_share_abstracti18napplicable_.abstracti18napplicable.html#geti18nkey">getI18NKey</a></p> <ul> <li>Defined in share/AbstractI18NApplicable.ts:56</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="geti18nvalue" class="tsd-anchor"></a> <h3>get<wbr>I18NValue</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>I18NValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_share_abstracti18napplicable_.abstracti18napplicable.html">AbstractI18NApplicable</a>.<a href="_share_abstracti18napplicable_.abstracti18napplicable.html#geti18nvalue">getI18NValue</a></p> <ul> <li>Defined in share/AbstractI18NApplicable.ts:79</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getitembyindex" class="tsd-anchor"></a> <h3>get<wbr>Item<wbr>ByIndex</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>ByIndex<span class="tsd-signature-symbol">(</span>idx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_component_inavigator_.inavigator.html">INavigator</a>.<a href="../interfaces/_component_inavigator_.inavigator.html#getitembyindex">getItemByIndex</a></p> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#getitembyindex">getItemByIndex</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:283</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get a <code>nav item</code> (<a href="_component_abstractnavitem_.abstractnavitem.html">AbstractNavItem</a>) from the given index (<code><b>idx</b></code>). </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>idx: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The index of <code>nav item</code> to get.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></h4> <p>Returns an instance of <code>nav item</code> (<a href="_component_abstractnavitem_.abstractnavitem.html">AbstractNavItem</a>) at the specified index (<code><b>idx</b></code>). Returns <code>null</code> if the given index is out of range.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getitembyname" class="tsd-anchor"></a> <h3>get<wbr>Item<wbr>ByName</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>ByName<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_component_inavigator_.inavigator.html">INavigator</a>.<a href="../interfaces/_component_inavigator_.inavigator.html#getitembyname">getItemByName</a></p> <p>Inherited from <a href="_component_abstractnavmenu_.abstractnavmenu.html">AbstractNavMenu</a>.<a href="_component_abstractnavmenu_.abstractnavmenu.html#getitembyname">getItemByName</a></p> <ul> <li>Defined in component/AbstractNavMenu.ts:301</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get a <code>nav item</code> (<a href="_component_abstractnavitem_.abstractnavitem.html">AbstractNavItem</a>) by the given <code><b>name</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of a <code>nav item</code> to get.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_component_menutoplayout_internal_menutopitem_component_.menutopitem.html" class="tsd-signature-type">MenuTopItem</a></h4> <p>Returns an instance of <code>nav item</code> (<a href="_component_abstractnavitem_.abstractnavitem.html">AbstractNavItem</a>) with the given <code><b>name</b></code>. Returns <code>null</code> if not found.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getitemcount" class="tsd-anchor"></a> <h3>get<wbr>Item<wbr>Count</h3> <ul class="t