39 lines
1.4 KiB
TypeScript
39 lines
1.4 KiB
TypeScript
|
import { BBox, IGroup, IShape } from '../../dependents';
|
||
|
|
import { LooseObject } from '../../interface';
|
||
|
|
import { GeometryLabelConstructor } from './base';
|
||
|
|
import { LabelItem } from './interface';
|
||
|
|
/**
|
||
|
|
* label 布局函数定义
|
||
|
|
* @param items 存储每个 label 的详细信息
|
||
|
|
* @param labels 所有的 labels 图形实例
|
||
|
|
* @param shapes 所有 label 对应的图形元素实例
|
||
|
|
* @param region 画布区域
|
||
|
|
* @param cfg 用于存储各个布局函数开放给用户的配置数据
|
||
|
|
*/
|
||
|
|
declare type GeometryLabelsLayoutFn = (items: LabelItem[], labels: IGroup[], shapes: IShape[] | IGroup[], region: BBox, cfg?: LooseObject) => void;
|
||
|
|
/**
|
||
|
|
* 获取 `type` 对应的 [[GeometryLabel]] 类
|
||
|
|
* @param type
|
||
|
|
* @returns
|
||
|
|
*/
|
||
|
|
export declare function getGeometryLabel(type: string): GeometryLabelConstructor;
|
||
|
|
/**
|
||
|
|
* 注册定义的 GeometryLabel 类
|
||
|
|
* @param type GeometryLabel 类型名称
|
||
|
|
* @param ctor GeometryLabel 类
|
||
|
|
*/
|
||
|
|
export declare function registerGeometryLabel(type: string, ctor: GeometryLabelConstructor): void;
|
||
|
|
/**
|
||
|
|
* 获取 `type` 对应的 [[GeometryLabelsLayoutFn]] label 布局函数
|
||
|
|
* @param type 布局函数名称
|
||
|
|
* @returns
|
||
|
|
*/
|
||
|
|
export declare function getGeometryLabelLayout(type: string): GeometryLabelsLayoutFn;
|
||
|
|
/**
|
||
|
|
* 注册定义的 label 布局函数
|
||
|
|
* @param type label 布局函数名称
|
||
|
|
* @param layoutFn label 布局函数
|
||
|
|
*/
|
||
|
|
export declare function registerGeometryLabelLayout(type: string, layoutFn: GeometryLabelsLayoutFn): void;
|
||
|
|
export {};
|