@ant-design/graphs
Version:
A React graph library based on Graphin
27 lines (26 loc) • 948 B
TypeScript
import type { GraphData, NodeData, TreeData } from '@antv/g6';
import type { GraphOptions } from '../../types';
export interface FishboneOptions extends Omit<GraphOptions, 'data'> {
/**
* The data.
*/
data?: GraphData | TreeData;
/**
* The default expand level. If not set, all nodes will be expanded.
*/
defaultExpandLevel?: number;
/**
* The type of the fishbone diagram.
* - `'decision'`: direction from left to right.
* - `'cause'`: direction from right to left.
* @default 'cause'
*/
type?: 'decision' | 'cause';
/**
* Selects a field from the data to use as the label for the node.
* If a string is provided, it will select the field as `data[labelField]`.
* If a function is provided, it will call the function with the data and use the returned value.
* @default (data) => data.id
*/
labelField?: string | ((node: NodeData) => string);
}