Class ShapeManager

Index

Constructors

Methods

loadFromDefinitions registerShape getShapeByNumber getShapeByNameAndFile hasShape renderShape getAllShapes clear getShapeCount exportDefinitions exportDefinitionsByCategory isBuiltinShape getNonBuiltinShapeCount getShapeCountByCategory

Constructors

constructor

new ShapeManager(): ShapeManager
Returns ShapeManager
- Defined in shape/ShapeManager.ts:25

Methods

loadFromDefinitions

loadFromDefinitions(shapeDefinitions: string, category?: string): number
从shape定义字符串加载shapes
Parameters
- shapeDefinitions: string
  shape定义字符串
- category: string = "document"
  shape分类（默认 "document"）
Returns number
加载的shape数量
- Defined in shape/ShapeManager.ts:38

registerShape

registerShape(definition: ShapeDefinition, category?: string): boolean
注册shape定义
Parameters
- definition: ShapeDefinition
  shape定义
- category: string = "custom"
  shape分类（默认 "custom"）
Returns boolean
是否注册成功
- Defined in shape/ShapeManager.ts:61

getShapeByNumber

getShapeByNumber(number: number): ShapeDefinition
获取shape定义（按编号）
Parameters
- number: number
  shape编号
Returns ShapeDefinition
shape定义或null
- Defined in shape/ShapeManager.ts:88

getShapeByNameAndFile

getShapeByNameAndFile(name: string, fileName: string): ShapeDefinition
获取shape定义（按名称和文件名）
Parameters
- name: string
  shape名称
- fileName: string
  文件名
Returns ShapeDefinition
shape定义或null
- Defined in shape/ShapeManager.ts:98

hasShape

hasShape(name: string, fileName: string): boolean
检查shape是否存在
Parameters
- name: string
  shape名称
- fileName: string
  文件名
Returns boolean
是否存在
- Defined in shape/ShapeManager.ts:109

renderShape

renderShape(
    name: string,
    fileName: string,
    options?: ShapeRenderOptions,
): ShapePath
渲染shape
Parameters
- name: string
  shape名称
- fileName: string
  文件名
- options: ShapeRenderOptions = {}
  渲染选项
Returns ShapePath
渲染后的路径或null
- Defined in shape/ShapeManager.ts:121

getAllShapes

getAllShapes(): ShapeDefinition[]
获取所有shape定义

Returns ShapeDefinition[]
shape定义数组
- Defined in shape/ShapeManager.ts:170

clear

clear(): void
清除所有shape定义

Returns void
- Defined in shape/ShapeManager.ts:177

getShapeCount

getShapeCount(): number
获取shape数量

Returns number
shape数量
- Defined in shape/ShapeManager.ts:186

exportDefinitions

exportDefinitions(): string
导出shape定义字符串

Returns string
shape定义字符串
- Defined in shape/ShapeManager.ts:194

exportDefinitionsByCategory

exportDefinitionsByCategory(category?: string): string
导出指定分类的shape定义字符串（排除内置shape）
Parameters
- Optionalcategory: string
  要导出的分类（可选）
  
  传入具体分类名：只导出该分类的shape
  
  传入 "all" 或不传：导出所有非内置分类的shape
Returns string
shape定义字符串
- Defined in shape/ShapeManager.ts:226

isBuiltinShape

isBuiltinShape(number: number): boolean
检查是否为内置shape
Parameters
- number: number
  shape编号
Returns boolean
是否为内置shape
- Defined in shape/ShapeManager.ts:287

getNonBuiltinShapeCount

getNonBuiltinShapeCount(): number
获取非内置shape的数量

Returns number
非内置shape数量
- Defined in shape/ShapeManager.ts:296

getShapeCountByCategory

getShapeCountByCategory(category: string): number
获取指定分类中的shape数量
Parameters
- category: string
  分类名称
Returns number
shape数量
- Defined in shape/ShapeManager.ts:306