ElementScheduler | spaniel

Hierarchy

BaseScheduler
- ElementScheduler

Implements

ElementSchedulerInterface

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ElementScheduler(customEngine?: EngineInterface, root?: Element): ElementScheduler

Overrides BaseScheduler.constructor
- Defined in metal/scheduler.ts:165
Parameters
- Optional customEngine: EngineInterface
- Optional root: Element
Returns ElementScheduler

Properties

Protected engine

engine: EngineInterface

Protected isTicking

isTicking: Boolean = false

Protected queue

queue: DOMQueue

Protected root

root: Element

Protected toRemove

toRemove: Array<string | Element | Function> = []

Methods

applyQueue

applyQueue(frame: Frame): void

Overrides BaseScheduler.applyQueue
- Defined in metal/scheduler.ts:170
Parameters
- frame: Frame
Returns void

queryElement

queryElement(el: Element, callback: function): void

Inherited from BaseScheduler.queryElement
- Defined in metal/scheduler.ts:107
Parameters
- el: Element
- callback: function
  - - (bcr: ClientRect, frame: Frame): void
    - Parameters
      - bcr: ClientRect
      - frame: Frame
      Returns void
Returns void

scheduleRead

scheduleRead(callback: Function): void

Inherited from BaseScheduler.scheduleRead
- Defined in metal/scheduler.ts:104
Parameters
- callback: Function
Returns void

scheduleWork

scheduleWork(callback: Function): void

Inherited from BaseScheduler.scheduleWork
- Defined in metal/scheduler.ts:101
Parameters
- callback: Function
Returns void

startTicking

startTicking(): void

Inherited from BaseScheduler.startTicking
- Defined in metal/scheduler.ts:124
Returns void

Protected tick

tick(): void

Inherited from BaseScheduler.tick
- Defined in metal/scheduler.ts:87
Returns void

unwatch

unwatch(id: string | Element | Function): void

Inherited from BaseScheduler.unwatch
- Defined in metal/scheduler.ts:118
Parameters
- id: string | Element | Function
Returns void

unwatchAll

unwatchAll(): void

Inherited from BaseScheduler.unwatchAll
- Defined in metal/scheduler.ts:121
Returns void

watch

watch(el: Element, callback: function, id?: string): string

- Defined in metal/scheduler.ts:177
Parameters
- el: Element
- callback: function
  - - (frame: FrameInterface, id: string, bcr: ClientRect): void
    - Parameters
      - frame: FrameInterface
      - id: string
      - bcr: ClientRect
      Returns void
- Optional id: string
Returns string

Generated using TypeDoc