Class PaintBrush

Hierarchy

PaintBrush

Index

Constructors

Accessors

Methods

action dispose off on once setCurrentColor show

Constructors

constructor

new PaintBrush(configs?): PaintBrush
Parameters
- configs: Partial<PaintBrushConfigs> = {}
Returns PaintBrush
- Defined in plugins/src/components/PaintBrush/index.ts:8

Accessors

configs

get configs(): PaintBrushConfigs
Returns PaintBrushConfigs
- Defined in plugins/src/components/PaintBrush/index.ts:55

state

get state(): Record<string, PaintBrushState[]>
获取画笔状态。

Returns Record<string, PaintBrushState[]>
- Defined in plugins/src/components/PaintBrush/index.ts:51

Methods

action

action(action): void
Parameters
- action: PaintBrushAction
Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:44

dispose

dispose(): void
销毁。

Deprecated

Description
画笔应该维护一个 全局单例，重复利用。

Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:66

off

off<K>(name, callback): void
Type Parameters
- K extends keyof PaintBrushEventMap
Parameters
- name: K
- callback: ((...args) => ReturnType<PaintBrushEventMap[K]>)
  - - (...args): ReturnType<PaintBrushEventMap[K]>
    - Parameters
      
      Rest ...args: Parameters<PaintBrushEventMap[K]>
      
      Returns ReturnType<PaintBrushEventMap[K]>
Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:24

on

on<K>(name, callback): void
Type Parameters
- K extends keyof PaintBrushEventMap
Parameters
- name: K
- callback: ((...args) => ReturnType<PaintBrushEventMap[K]>)
  - - (...args): ReturnType<PaintBrushEventMap[K]>
    - Parameters
      
      Rest ...args: Parameters<PaintBrushEventMap[K]>
      
      Returns ReturnType<PaintBrushEventMap[K]>
Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:18

once

once<K>(name, callback): void
Type Parameters
- K extends keyof PaintBrushEventMap
Parameters
- name: K
- callback: ((...args) => ReturnType<PaintBrushEventMap[K]>)
  - - (...args): ReturnType<PaintBrushEventMap[K]>
    - Parameters
      
      Rest ...args: Parameters<PaintBrushEventMap[K]>
      
      Returns ReturnType<PaintBrushEventMap[K]>
Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:31

setCurrentColor

setCurrentColor(color): void
Parameters
- color: string
Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:70

show

show(): void
显示画笔。

Returns void
- Defined in plugins/src/components/PaintBrush/index.ts:40