@antv/g6
Version:
A Graph Visualization Framework in JavaScript
27 lines (26 loc) • 1.12 kB
TypeScript
import { DisplayObjectConfig, Group, TextStyleProps } from '@antv/g';
import type { BaseShapeStyleProps } from './base-shape';
import { BaseShape } from './base-shape';
import type { ImageStyleProps } from './image';
/**
* <zh/> 图标样式
*
* <en/> Icon style
*/
export interface IconStyleProps extends BaseShapeStyleProps, Partial<TextStyleProps>, Omit<ImageStyleProps, 'z'> {
}
/**
* <zh/> 图标
*
* <en/> Icon
* @remarks
* <zh/> 图标是一种特殊的图形，可以是图片或者文字。传入 src 属性时，会渲染图片；传入 text 属性时，会渲染文字。
*
* <en/> Icon is a special shape, which can be an image or text. When the src attribute is passed in, an image will be rendered; when the text attribute is passed in, text will be rendered.
*/
export declare class Icon extends BaseShape<IconStyleProps> {
constructor(options: DisplayObjectConfig<IconStyleProps>);
private isImage;
protected getIconStyle(attributes?: IconStyleProps): IconStyleProps;
render(attributes?: IconStyleProps & import("@antv/g").BaseCustomElementStyleProps, container?: Group): void;
}