Element 图形元素。
定义:在 G2 中,我们会将数据通过图形语法映射成不同的图形,比如点图,数据集中的每条数据会对应一个点,柱状图每条数据对应一个柱子,线图则是一组数据对应一条折线,Element 即一条/一组数据对应的图形元素,它代表一条数据或者一个数据集,在图形层面,它可以是单个 Shape 也可以是多个 Shape,我们称之为图形元素。
属性
animate
• animate: AnimateOption | boolean
shape 的动画配置
container
• container: IGroup
shape 容器
destroyed
• destroyed: boolean = false
标识对象是否已销毁
geometry
• geometry: Geometry
element 对应的 Geometry 实例
labelShape
• labelShape: IGroup[]
保存 shape 对应的 label
shape
• shape: IShape | IGroup
最后创建的图形对象
shapeFactory
• shapeFactory: ShapeFactory
用于创建各种 shape 的工厂对象
visible
• visible: boolean
是否可见
方法
changeVisible
▸ changeVisible(visible
: boolean): void
显示或者隐藏 element。
Parameters:
属性名 | 类型 | 描述 |
---|---|---|
visible |
boolean | 是否可见。 |
Returns: void
clearStates
▸ clearStates(): void
清空状量态,恢复至初始状态。
Returns: void
destroy
▸ destroy(): void
销毁 element 实例。
Returns: void
getBBox
▸ getBBox(): BBox
返回 Element 元素整体的 bbox,包含文本及文本连线(有的话)。
Returns: BBox
整体包围盒。
getData
▸ getData(): object
获取 Element 对应的原始数据。
Returns: object
getModel
▸ getModel(): ShapeInfo
获取 Element 对应的图形绘制数据。
Returns: ShapeInfo
图形绘制数据。
getStates
▸ getStates(): string[]
获取当前 Element 上所有的状态。
Returns: string[]
hasState
▸ hasState(stateName
): boolean
查询当前 Element 上是否已设置 stateName
对应的状态。
Parameters:
属性名 | 类型 | 描述 |
---|---|---|
stateName |
string | 状态名称。 |
Returns: boolean
hide
▸ hide(): void
隐藏。
Returns: void
setState
▸ setState(stateName
, stateStatus
): void
设置 Element 的状态。
目前 Element 开放三种状态:
- active
- selected
- inactive
这三种状态相互独立,可以进行叠加。
这三种状态的样式可在 Theme 主题中或者通过 geometry.state()
接口进行配置。
// 激活 active 状态
setState('active', true);
Parameters:
属性名 | 类型 | 描述 |
---|---|---|
stateName |
string | 状态名 |
stateStatus |
boolean | 是否开启状态 |
Returns: void
show
▸ show(): void
显示。
Returns: void