Interface WrappedParentIds<ParIds>

What gets returned by Stratify#parentData() when Stratify#parentIds is set.

Type Parameters

Hierarchy

  • ParentData<ParIds extends ParentIds<infer N>
        ? N
        : never, undefined>
    • WrappedParentIds
  • get parent ids and link data from a node datum

    Parameters

    • datum: ParIds extends ParentIds<N>
          ? N
          : never

      the node data to get parent ids from

    • index: number

      the order that the datum was encountered in

    Returns undefined | Iterable<readonly [string, undefined]>

    parentData - the parent ids and link data that correspond to the node datum, undefined is the same as empty

Properties

Properties

wrapped: ParIds

the wrapped parent ids operator

Generated using TypeDoc