d3-graph-controller
Version:
A TypeScript library for visualizing and simulating directed, interactive graphs.
35 lines (34 loc) • 1.22 kB
text/typescript
import { LinkFilter } from './filter.mjs';
import { NodeTypeToken } from '../model/graph.mjs';
import { GraphLink } from '../model/link.mjs';
import { GraphNode } from '../model/node.mjs';
/**
* Initial settings of a controller.
*/
export interface InitialGraphSettings<T extends NodeTypeToken, Node extends GraphNode<T>, Link extends GraphLink<T, Node>> {
/**
* Whether nodes without incoming or outgoing links will be shown or not.
*/
readonly includeUnlinked: boolean;
/**
* Link filter that decides whether links should be included or not.
*/
readonly linkFilter: LinkFilter<T, Node, Link>;
/**
* Node types that should be included.
* If undefined, all node types will be included.
*/
readonly nodeTypeFilter?: T[] | undefined;
/**
* Whether link labels are shown or not.
*/
readonly showLinkLabels: boolean;
/**
* Whether node labels are shown or not.
*/
readonly showNodeLabels: boolean;
}
/**
* Create default initial settings.
*/
export declare function createDefaultInitialGraphSettings<T extends NodeTypeToken, Node extends GraphNode<T>, Link extends GraphLink<T, Node>>(): InitialGraphSettings<T, Node, Link>;