Class RTCSketchpad

Hierarchy

EventTarget
- RTCSketchpad

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new RTCSketchpad(options: RTCSketchpadOptions): RTCSketchpad

Overrides EventTarget.constructor

Parameters
- options: RTCSketchpadOptions
Returns RTCSketchpad

Properties

_canvasDOM

_canvasDOM: HTMLCanvasElement

_ctx

_ctx: CanvasRenderingContext2D

_endPoint

_endPoint: Point

_options

_options: RTCSketchpadOptions

_revoke

_revoke: () => void

Type declaration

- (): void
- Returns void

_startPoint

_startPoint: Point

_state

_state: RTCSketchpadState

_uniqueRandomId

_uniqueRandomId: string

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

Static reporter

reporter: Reporter = new Reporter('RTCSketchpad')

Methods

_sketchpadInit

_sketchpadInit(): (Anonymous function)

Returns (Anonymous function)

addEventListener

addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from EventTarget.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void

若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - Returns void

addEventListeners

addEventListeners(types: Array<EventTargetType>, func: EventListenerType, options?: EventListenerOptions): false | (Anonymous function)

Inherited from EventTarget.addEventListeners

对多个事件添加同一个事件监听器

Parameters
- types: Array<EventTargetType>
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
  
  设置监听器参数
Returns false | (Anonymous function)

若添加成功则返回一个函数, 用于移除事件监听

attach

attach(selector: string): boolean

绑定一个已存在的{@link HTMLCanvasElement}

Parameters
- selector: string
  
  该{@link HTMLCanvasElement}的css选择器
Returns boolean

capture

capture(frameRate?: number): MediaStream

Parameters
- Default value frameRate: number = 25
Returns MediaStream

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

destroy

destroy(): void

Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

分发事件

Parameters
- event: Event
  
  分发的事件对象
Returns boolean

事件是否发送成功

dispatchEventLite

dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): void

Inherited from EventTarget.dispatchEventLite

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
Returns void

generate

generate(selector: string): boolean

生成一个内置的画板, 该方法默认会进行绑定无需再调用attach

Parameters
- selector: string
  
  指定画板应被放置在那个dom元素中
Returns boolean

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

指定类型的事件是否被监听

Parameters
- type: EventTargetType
Returns boolean

removeEventListener

removeEventListener(type: EventTargetType, func: EventListenerType): boolean

Inherited from EventTarget.removeEventListener

移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

Parameters
- type: EventTargetType
  
  要移除的事件监听器类型
- func: EventListenerType
  
  要移除的事件监听器
Returns boolean

返回true表示有该fun监听器并且移除成功

Object literals

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: object

once

once: false = false

Static DEFAULT_SKETCHPAD_OPTIONS

DEFAULT_SKETCHPAD_OPTIONS: object

height

height: number = 200

width

width: number = 300

Generated using TypeDoc