mirror of
https://gitee.com/antv/g6.git
synced 2024-12-15 18:11:08 +08:00
78 lines
2.6 KiB
Markdown
78 lines
2.6 KiB
Markdown
|
---
|
|||
|
|
title: ComboModel
|
|||
|
|
order: 8
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
ComboModel is the combo data that is internally circulated, which is calculated from `ComboUserModel` through transformations on the graph instance. The data you consume anywhere later is based on this data. Each item in Combo inherits from [`ComboUserModel`](./ComboUserModel.en.md) and is defined as follows after extension:
|
|||
|
|
|
|||
|
|
```typescript
|
|||
|
|
interface ComboModel {
|
|||
|
|
id: string | number;
|
|||
|
|
data: ComboModelData; // = ComboModelData
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## id
|
|||
|
|
|
|||
|
|
The unique ID of the combo. After the combo is created, the ID cannot be modified.
|
|||
|
|
|
|||
|
|
- **Required**: True;
|
|||
|
|
- **Type**: `string|number`
|
|||
|
|
|
|||
|
|
## data
|
|||
|
|
|
|||
|
|
The data in InnerModelData has been generated from UserModelData through a series of transform functions on the graph instance. The business data may have been transformed, filtered, and merged.
|
|||
|
|
|
|||
|
|
- **Required**: True;
|
|||
|
|
- **Type**: `ComboModelData`, the definition is the same as [`ComboUserModel`](./ComboUserModel.en.md#ComboModelDatatype), as follows:
|
|||
|
|
|
|||
|
|
### ComboModelData.type
|
|||
|
|
|
|||
|
|
The rendering type of the combo, which can be a combo type registered on the graph class. The built-in and default registered types are `'circle-combo'` and `'rect-combo'`. The default is `'circle-combo'`.
|
|||
|
|
|
|||
|
|
- **Required**: False;
|
|||
|
|
- **Type**: `string`；
|
|||
|
|
|
|||
|
|
### ComboModelData.visible
|
|||
|
|
|
|||
|
|
Whether the combo is displayed by default.
|
|||
|
|
|
|||
|
|
- **Required**: False;
|
|||
|
|
- **Type**: `boolean`；
|
|||
|
|
|
|||
|
|
### ComboModelData.color
|
|||
|
|
|
|||
|
|
The theme color of the key shape (`keyShape`) of the combo, with a value in hexadecimal string format. Provided for simple configuration. More style configurations should be configured in the Combo mapper of the graph instance, including keyShape and various graphic styles.
|
|||
|
|
|
|||
|
|
- **Required**: False;
|
|||
|
|
- **Type**: `string`；
|
|||
|
|
|
|||
|
|
### ComboModelData.label
|
|||
|
|
|
|||
|
|
The text content of the `labelShape` of the combo. Provided for simple configuration. More style configurations should be configured in the Combo mapper of the graph instance, including the `text` value of `labelShape` or other graphic styles.
|
|||
|
|
|
|||
|
|
- **Required**: False;
|
|||
|
|
- **Type**: `string`；
|
|||
|
|
|
|||
|
|
### ComboModelData.icon
|
|||
|
|
|
|||
|
|
The configuration of the icon on the combo. The built-in combo's icon is drawn after the text. Provided for simple configuration. More style configurations should be configured in the Combo mapper of the graph instance, including the graphic style of the iconShape.
|
|||
|
|
|
|||
|
|
- **Required**: False;
|
|||
|
|
- **Type**:
|
|||
|
|
|
|||
|
|
```typescript
|
|||
|
|
{
|
|||
|
|
type: 'text' | 'icon',
|
|||
|
|
img?: string, // Required when type is 'text'
|
|||
|
|
text?: string, // Required when type is 'icon'
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### ComboModelData.parentId
|
|||
|
|
|
|||
|
|
The ID of the parent combo to which the combo belongs. `undefined` means it is a root.
|
|||
|
|
|
|||
|
|
- **Required**: False;
|
|||
|
|
- **Type**: `string | number`；
|