Class RecordNavItem

The resulting object of calling [[BaseRecord.nav]]

Example: ```javascript TODO ```

Implements

MergeTagable

Constructors

constructor

new RecordNavItem(): RecordNavItem
Returns RecordNavItem

Methods

childCount

childCount(): number
A number value indicating the number of child objects available from this object.

Returns number
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11989

children

children(): EList<RecordNavItem>
This property is an array of [[RelateNavItem]] starting at 0 and representing the child objects of this object.

Returns EList<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11908

icon

icon(): string
A string containing the URL of the standard BlueStep icon corresponding to the type of element.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11926

iconHtml

iconHtml(): string
A string containing an HTML img tag which will display the standard BlueStep icon corresponding to the type of element.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11935

id

id(): string
A string containing the internal id of the Relate element represented by this object.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11953

index

index(): number
A number containing the index of the current object in its parent's list of children.

Returns number
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11980

isLeaf

isLeaf(): boolean
A boolean value indicating whether this element is childless. Said another way, this value is false for folders and true for everything else.

Returns boolean
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12007

isRoot

isRoot(): boolean
A boolean value indicating whether this is the root element. The root element is a folder named "root", is at level 0, and has no parent. The root is available even if folders are excluded.

Returns boolean
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11998

label

label(): string
A string containing the name/label of the Relate element represented by this object.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11962

level

level(): number
A number indicating the level of the element within the navigation tree. Top level elements are at level 1. Children of these navigation items are level 2. Children of level 2 are level 3 and so forth.

Returns number
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11899

mergeTag

mergeTag(options?: string): string
Parameters
- Optionaloptions: string
Returns string
Implementation of MergeTagable.mergeTag
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12149

name

name(): string
A string containing the name/label of the Relate element represented by this object.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11971

optFindById

optFindById(id: string): Optional<RecordNavItem>
Lookup nav item using full id string.
Parameters
- id: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12125

optFindByLabel

optFindByLabel(
    name: string,
    value?: string,
    fullTree?: boolean,
): Optional<RecordNavItem>
This function finds a child element with a specific label. The type parameter is a single character String value indicating what type of element to look for. The possibilities are "f" for form, "r" for merge-report, "w" for wizard and "_" for folder. If the seachAll parameter is true, then the function also searches the children of the children, and their children until all sub-elements of the current object have been searched. It does this via a depth traversal, meaning that if two elements have the label that is being searched for, it will choose an element with a smaller 'level' value over an element with a higher 'level' value. If the elements are at the same level, it will choose the one that comes first.
Parameters
- name: string
- Optionalvalue: string
- OptionalfullTree: boolean
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12103

optFindByName

optFindByName(
    name: string,
    value?: string,
    fullTree?: boolean,
): Optional<RecordNavItem>
This function works precisely like [[findByLabel]] but searches by name instead of label.
Parameters
- name: string
- Optionalvalue: string
- OptionalfullTree: boolean
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12115

optLookupBsJsMergeReport

optLookupBsJsMergeReport(name: string, value: string): Optional<RecordNavItem>
Lookup bluestep.js Merge Report by using custom lookup property.
Parameters
- name: string
- value: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12080

optLookupFixedReport

optLookupFixedReport(name: string, value: string): Optional<RecordNavItem>
Lookup Fixed Merge Report by using custom lookup property.
Parameters
- name: string
- value: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12091

optLookupFolder

optLookupFolder(name: string, value: string): Optional<RecordNavItem>
Lookup folder by using custom lookup property.
Parameters
- name: string
- value: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12036

optLookupForm

optLookupForm(name: string, value: string): Optional<RecordNavItem>
Lookup form by using custom lookup property.
Parameters
- name: string
- value: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12058

optLookupMergeReport

optLookupMergeReport(name: string, value: string): Optional<RecordNavItem>
Lookup RelateScript Merge Report by using custom lookup property.
Parameters
- name: string
- value: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12069

optLookupWizard

optLookupWizard(name: string, value: string): Optional<RecordNavItem>
Lookup wizard by using custom lookup property.
Parameters
- name: string
- value: string
Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12047

optParent

optParent(): Optional<RecordNavItem>
This property is another [[RelateNavItem]] representing the parent of this object. Will be empty if [[isRoot]] is true.

Returns Optional<RecordNavItem>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12016

optSearch

optSearch(
    search: (json: string) => boolean,
    value?: string,
    fullTree?: boolean,
): Optional<RecordNavItem>
General purpose searching using the call back function search to identify the child.
Parameters
- search: (json: string) => boolean
- Optionalvalue: string
- OptionalfullTree: boolean
Returns Optional<RecordNavItem>
Example
```
//Find the first folder called 'john'node.search(
  json -> {
    const obj = JSON.parse(json); 
    return ('alt' in obj) && 'john' === obj.alt;
  },
  '_', true);
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12143

record

record(): BaseRecord<any>
The [[BaseRecord]] of this [[RelateNavItem]]

Returns BaseRecord<any>
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:12025

typeName

typeName(): string
A string indicating the type of Relate element represented by this object.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11917

url

url(): string
A string containing the URL of the Relate element represented by this object.

Returns string
Example
```
TODO
```
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:11944

Class RecordNavItem

Example: ```javascript TODO ```

Implements

Index

Constructors

Methods

Constructors

constructor

Returns RecordNavItem

Methods

childCount

Returns number

Example

children

Returns EList<RecordNavItem>

Example

icon

Returns string

Example

iconHtml

Returns string

Example

id

Returns string

Example

index

Returns number

Example

isLeaf

Returns boolean

Example

isRoot

Returns boolean

Example

label

Returns string

Example

level

Returns number

Example

mergeTag

Parameters

Returns string

name

Returns string

Example

optFindById

Parameters

Returns Optional<RecordNavItem>

Example

optFindByLabel

Parameters

Returns Optional<RecordNavItem>

Example

optFindByName

Parameters

Returns Optional<RecordNavItem>

Example

optLookupBsJsMergeReport

Parameters

Returns Optional<RecordNavItem>

Example

optLookupFixedReport

Parameters

Returns Optional<RecordNavItem>

Example

optLookupFolder

Parameters

Returns Optional<RecordNavItem>

Example

optLookupForm

Parameters

Returns Optional<RecordNavItem>

Example

optLookupMergeReport

Parameters

Returns Optional<RecordNavItem>

Example

optLookupWizard

Parameters