g6/packages/site/docs/apis/data/EdgeModel.en.md
Aaron 3534d4669b
docs: adjust docs of data (#5211)
* docs: adjust docs of data

* docs: update api docs
2023-12-01 17:44:49 +08:00

29 lines
891 B
Markdown

---
title: EdgeModel
order: 7
---
EdgeModel is the internal edge data, which is obtained by [EdgeUserModel](./EdgeUserModel.en.md) through [transforms](./DataIntro.en.md#transforms).
<embed src="../../common/DataInnerModelTips.en.md"></embed>
<embed src="../../common/DataID.en.md"></embed>
## source <Badge type="error">Required</Badge>
**Type**: `string | number`
The ID of the source node of the edge, which should correspond to an item in `nodes`. Otherwise, the edge data will not be added to the graph.
## target <Badge type="error">Required</Badge>
**Type**: `string | number`
The ID of the target node of the edge, which should correspond to an item in nodes. Otherwise, the edge data will not be added to the graph.
## data <Badge type="error">Required</Badge>
<embed src="../../common/DataAttrTips.en.md"></embed>
<embed src="../../common/EdgeUserModel.en.md"></embed>