@antv/g6/lib/elements/shapes/contour.d.ts

A Graph Visualization Framework in JavaScript

import type { DisplayObjectConfig, Group, PathStyleProps } from '@antv/g';
import type { CardinalPlacement, Prefix } from '../../types';
import type { LabelStyleProps } from '../shapes';
import { BaseShape } from './base-shape';
export interface ContourLabelStyleProps extends LabelStyleProps {
    /**
     * <zh/> 标签位置
     *
     * <en/> Label position
     * @defaultValue 'bottom'
     */
    placement?: CardinalPlacement | 'center';
    /**
     * <zh/> 标签是否贴合轮廓
     *
     * <en/> Whether the label is close to the contour
     * @defaultValue true
     */
    closeToPath?: boolean;
    /**
     * <zh/> 标签是否跟随轮廓旋转，仅在 closeToPath 为 true 时生效
     *
     * <en/> Whether the label rotates with the contour. Only effective when closeToPath is true
     * @defaultValue true
     */
    autoRotate?: boolean;
    /**
     * <zh/> x 轴偏移量
     *
     * <en/> Label x-axis offset
     * @defaultValue 0
     */
    offsetX?: number;
    /**
     * <zh/> y 轴偏移量
     *
     * <en/> Label y-axis offset
     * @defaultValue 0
     */
    offsetY?: number;
    /**
     * <zh/> 文本的最大宽度，超出会自动省略
     *
     * <en/> The maximum width of the text, which will be automatically ellipsis if exceeded
     */
    maxWidth?: number;
}
export interface ContourStyleProps extends PathStyleProps, Prefix<'label', ContourLabelStyleProps> {
    /**
     * <zh/> 是否显示标签
     *
     * <en/> Whether to display the label
     * @defaultValue true
     */
    label?: boolean;
}
type ParsedContourStyleProps = Required<ContourStyleProps>;
type ContourOptions = DisplayObjectConfig<ContourStyleProps>;
export declare class Contour extends BaseShape<ContourStyleProps> {
    static defaultStyleProps: Partial<ContourStyleProps>;
    constructor(options: ContourOptions);
    protected getLabelStyle(attributes: ParsedContourStyleProps): LabelStyleProps | false;
    protected getKeyStyle(attributes: ParsedContourStyleProps): PathStyleProps;
    render(attributes: ParsedContourStyleProps, container: Group): void;
}
export {};