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

Example

TODO

Hierarchy

  • RecordNavItem

Implements

Constructors

Methods

  • A number value indicating the number of child objects available from this object.

    Returns number

    Example

    TODO
    
  • This property is an array of [[RelateNavItem]] starting at 0 and representing the child objects of this object.

    Returns EList<RecordNavItem>

    Example

    TODO
    
  • A string containing the URL of the standard BlueStep icon corresponding to the type of element.

    Returns string

    Example

    TODO
    
  • A string containing an HTML img tag which will display the standard BlueStep icon corresponding to the type of element.

    Returns string

    Example

    TODO
    
  • A string containing the internal id of the Relate element represented by this object.

    Returns string

    Example

    TODO
    
  • A number containing the index of the current object in its parent's list of children.

    Returns number

    Example

    TODO
    
  • 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
    
  • 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
    
  • A string containing the name/label of the Relate element represented by this object.

    Returns string

    Example

    TODO
    
  • 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
    
  • Parameters

    • Optional options: string

    Returns string

  • A string containing the name/label of the Relate element represented by this object.

    Returns string

    Example

    TODO
    
  • 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
    • Optional value: string
    • Optional fullTree: boolean

    Returns Optional<RecordNavItem>

    Example

    TODO
    
  • This function works precisely like [[findByLabel]] but searches by name instead of label.

    Parameters

    • name: string
    • Optional value: string
    • Optional fullTree: boolean

    Returns Optional<RecordNavItem>

    Example

    TODO
    
  • Lookup bluestep.js Merge Report by using custom lookup property.

    Parameters

    • name: string
    • value: string

    Returns Optional<RecordNavItem>

    Example

    TODO
    
  • Lookup Fixed Merge Report by using custom lookup property.

    Parameters

    • name: string
    • value: string

    Returns Optional<RecordNavItem>

    Example

    TODO
    
  • Lookup RelateScript Merge Report by using custom lookup property.

    Parameters

    • name: string
    • value: string

    Returns Optional<RecordNavItem>

    Example

    TODO
    
  • This property is another [[RelateNavItem]] representing the parent of this object. Will be empty if [[isRoot]] is true.

    Returns Optional<RecordNavItem>

    Example

    TODO
    
  • General purpose searching using the call back function search to identify the child.

    Parameters

    • search: ((json) => boolean)
        • (json): boolean
        • Parameters

          • json: string

          Returns boolean

    • Optional value: string
    • Optional fullTree: 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);
  • The [[BaseRecord]] of this [[RelateNavItem]]

    Returns BaseRecord<any>

    Example

    TODO
    
  • A string indicating the type of Relate element represented by this object.

    Returns string

    Example

    TODO
    
  • A string containing the URL of the Relate element represented by this object.

    Returns string

    Example

    TODO
    

Generated using TypeDoc