Marcus Andersson
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
162 lines
2.8 KiB
Markdown
162 lines
2.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "NavModelItem"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## NavModelItem interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface NavModelItem
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { NavModelItem } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [active](#active-property) | <code>boolean</code> | |
|
|
| [breadcrumbs](#breadcrumbs-property) | <code>NavModelBreadcrumb[]</code> | |
|
|
| [children](#children-property) | <code>NavModelItem[]</code> | |
|
|
| [divider](#divider-property) | <code>boolean</code> | |
|
|
| [hideFromMenu](#hidefrommenu-property) | <code>boolean</code> | |
|
|
| [hideFromTabs](#hidefromtabs-property) | <code>boolean</code> | |
|
|
| [icon](#icon-property) | <code>string</code> | |
|
|
| [id](#id-property) | <code>string</code> | |
|
|
| [img](#img-property) | <code>string</code> | |
|
|
| [parentItem](#parentitem-property) | <code>NavModelItem</code> | |
|
|
| [showOrgSwitcher](#showorgswitcher-property) | <code>boolean</code> | |
|
|
| [subTitle](#subtitle-property) | <code>string</code> | |
|
|
| [target](#target-property) | <code>string</code> | |
|
|
| [text](#text-property) | <code>string</code> | |
|
|
| [url](#url-property) | <code>string</code> | |
|
|
|
|
### active property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
active?: boolean;
|
|
```
|
|
|
|
### breadcrumbs property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
breadcrumbs?: NavModelBreadcrumb[];
|
|
```
|
|
|
|
### children property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
children?: NavModelItem[];
|
|
```
|
|
|
|
### divider property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
divider?: boolean;
|
|
```
|
|
|
|
### hideFromMenu property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
hideFromMenu?: boolean;
|
|
```
|
|
|
|
### hideFromTabs property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
hideFromTabs?: boolean;
|
|
```
|
|
|
|
### icon property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
icon?: string;
|
|
```
|
|
|
|
### id property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
id?: string;
|
|
```
|
|
|
|
### img property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
img?: string;
|
|
```
|
|
|
|
### parentItem property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
parentItem?: NavModelItem;
|
|
```
|
|
|
|
### showOrgSwitcher property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
showOrgSwitcher?: boolean;
|
|
```
|
|
|
|
### subTitle property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
subTitle?: string;
|
|
```
|
|
|
|
### target property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
target?: string;
|
|
```
|
|
|
|
### text property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
text: string;
|
|
```
|
|
|
|
### url property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
url?: string;
|
|
```
|