Interface Stratify<LinkDatum, Ops>

The operator that constructs a MutGraph from stratified tabularesque data.

Create a default operator with graphStratify. The accessors for a node's id or parents' ids can be altered, or parentData can be specified to specify parent ids and attach data to the edge for that parent.

interface Stratify<LinkDatum, Ops extends StratifyOps<never, LinkDatum>> {
    id<NewId extends Id>(
        id: NewId,
    ): Stratify<LinkDatum, U<Ops, "id", NewId>>;
    id(): Ops["id"];
    parentData<
        NewLinkDatum,
        NewParentData extends ParentData<never, NewLinkDatum>,
    >(
        data: NewParentData & ParentData<never, NewLinkDatum>,
    ): Stratify<
        NewLinkDatum,
        {
            id: Ops["id"];
            parentData: NewParentData;
            parentIds: WrappedParentData<NewParentData>;
        },
    >;
    parentData(): Ops["parentData"];
    parentIds<NewParentIds extends ParentIds<never>>(
        ids: NewParentIds,
    ): Stratify<
        undefined,
        {
            id: Ops["id"];
            parentData: WrappedParentIds<NewParentIds>;
            parentIds: NewParentIds;
        },
    >;
    parentIds(): Ops["parentIds"];
    <N extends unknown>(data: readonly N[]): MutGraph<N, LinkDatum>;
}

Type Parameters

LinkDatum
Ops extends StratifyOps<never, LinkDatum>

Stratify<N extends unknown>(data: readonly N[]): MutGraph<N, LinkDatum>
create a graph from stratify data
Type Parameters
- N extends unknown
Parameters
- data: readonly N[]
  the node data to create a graph from
Returns MutGraph<N, LinkDatum>
graph - the graph representation of the data
- Defined in graph/stratify.ts:108

Index

Methods

id parentData parentIds

Methods

id

id<NewId extends Id>(id: NewId): Stratify<LinkDatum, U<Ops, "id", NewId>>
Sets the id accessor to the given Id and returns a Stratify. The default operator is:
```
function id(d) {
  return d.id;
}
```
Type Parameters
- NewId extends Id
Parameters
- id: NewId
Returns Stratify<LinkDatum, U<Ops, "id", NewId>>
- Defined in graph/stratify.ts:122
id(): Ops["id"]
Gets the current id accessor.

Returns Ops["id"]
- Defined in graph/stratify.ts:126

parentData

parentData<NewLinkDatum, NewParentData extends ParentData<never, NewLinkDatum>>(
    data: NewParentData & ParentData<never, NewLinkDatum>,
): Stratify<
    NewLinkDatum,
    {
        id: Ops["id"];
        parentData: NewParentData;
        parentIds: WrappedParentData<NewParentData>;
    },
>
Sets the parentData accessor to the given ParentData and returns an updated operator.
Type Parameters
- NewLinkDatum
- NewParentData extends ParentData<never, NewLinkDatum>
Parameters
- data: NewParentData & ParentData<never, NewLinkDatum>
Returns Stratify<
    NewLinkDatum,
    {
        id: Ops["id"];
        parentData: NewParentData;
        parentIds: WrappedParentData<NewParentData>;
    },
>
- Defined in graph/stratify.ts:162
parentData(): Ops["parentData"]
Gets the current parentData accessor. If parentIds was passed, this will wrap that to just return the ids with undefined data.

Returns Ops["parentData"]
- Defined in graph/stratify.ts:183

parentIds

parentIds<NewParentIds extends ParentIds<never>>(
    ids: NewParentIds,
): Stratify<
    undefined,
    {
        id: Ops["id"];
        parentData: WrappedParentIds<NewParentIds>;
        parentIds: NewParentIds;
    },
>
Sets the parentIds accessor to the given ParentIds and returns an update operator. The default operator is:
```
function parentIds(d) {
  return d.parentIds;
}
```
Type Parameters
- NewParentIds extends ParentIds<never>
Parameters
- ids: NewParentIds
Returns Stratify<
    undefined,
    {
        id: Ops["id"];
        parentData: WrappedParentIds<NewParentIds>;
        parentIds: NewParentIds;
    },
>
- Defined in graph/stratify.ts:138
parentIds(): Ops["parentIds"]
Gets the current parent ids accessor. If parentData was passed, the returned function will wrap that to just return the ids.

Returns Ops["parentIds"]
- Defined in graph/stratify.ts:156

Interface Stratify<LinkDatum, Ops>

Type Parameters

Type Parameters

Parameters

Returns MutGraph<N, LinkDatum>

Index

Methods

Methods

id

Type Parameters

Parameters

Returns Stratify<LinkDatum, U<Ops, "id", NewId>>

Returns Ops["id"]

parentData

Type Parameters

Parameters

Returns Stratify<
    NewLinkDatum,
    {
        id: Ops["id"];
        parentData: NewParentData;
        parentIds: WrappedParentData<NewParentData>;
    },
>

Returns Ops["parentData"]

parentIds

Type Parameters

Parameters

Returns Stratify<
    undefined,
    {
        id: Ops["id"];
        parentData: WrappedParentIds<NewParentIds>;
        parentIds: NewParentIds;
    },
>

Returns Ops["parentIds"]

Settings

On This Page

Interface Stratify<LinkDatum, Ops>

Type Parameters

Type Parameters

Parameters

Returns MutGraph<N, LinkDatum>

Index

Methods

Methods

id

Type Parameters

Parameters

Returns Stratify<LinkDatum, U<Ops, "id", NewId>>

Returns Ops["id"]

parentData

Type Parameters

Parameters

Returns Stratify< NewLinkDatum, { id: Ops["id"]; parentData: NewParentData; parentIds: WrappedParentData<NewParentData>; },>

Returns Ops["parentData"]

parentIds

Type Parameters

Parameters

Returns Stratify< undefined, { id: Ops["id"]; parentData: WrappedParentIds<NewParentIds>; parentIds: NewParentIds; },>

Returns Ops["parentIds"]

Settings

On This Page

Returns Stratify<
NewLinkDatum,
{
id: Ops["id"];
parentData: NewParentData;
parentIds: WrappedParentData<NewParentData>;
},
>

Returns Stratify<
undefined,
{
id: Ops["id"];
parentData: WrappedParentIds<NewParentIds>;
parentIds: NewParentIds;
},
>