Interface Render2dType

animation

Optional dom

handler

id

painter

storage

add

• add(el): void

• 添加元素

  Parameters

  • el: Element<ElementProps>

  Returns void

clear

• clear(): void

• Clear all objects and the canvas.

  Returns void

clearAnimation

• clearAnimation(): void

• Stop and clear all animation immediately

  Returns void

configLayer

• configLayer(zLevel, config): void

• Change configuration of layer

  Parameters

  • zLevel: number

  • config: LayerConfig

  Returns void

dispose

• dispose(): void

• Dispose self.

  Returns void

findHover

• findHover(x, y): {
      target: Displayable<DisplayableProps>;
      topTarget: Displayable<DisplayableProps>;
  }

• Find hovered element

  Parameters

  • x: number

  • y: number

  Returns {
      target: Displayable<DisplayableProps>;
      topTarget: Displayable<DisplayableProps>;
  }

  • target: Displayable<DisplayableProps>

  • topTarget: Displayable<DisplayableProps>

flush

• flush(): void

• Perform all refresh

  Returns void

getBackgroundColor

• getBackgroundColor(): string | GradientObject | PatternObject

• Returns string | GradientObject | PatternObject

getHeight

• getHeight(): number

• Get container height

  Returns number

getWidth

• getWidth(): number

• Get container width

  Returns number

isDarkMode

• isDarkMode(): boolean

• Returns boolean

off

• off(eventName?, eventHandler?): void

• Unbind event

  Parameters

  • Optional eventName: string

    Event name

  • Optional eventHandler: ((...args) => boolean | void)

    Handler function

    • • (...args): boolean | void

      • Parameters

        • Rest ...args: any[]

        Returns boolean | void

  Returns void

on

• on<Ctx>(eventName, eventHandler, context?): this

• Type Parameters

  • Ctx

  Parameters

  • eventName: ElementEventName

  • eventHandler: ElementEventCallback<Ctx, Render2dType>

  • Optional context: Ctx

  Returns this

• on<Ctx>(eventName, eventHandler, context?): this

• Type Parameters

  • Ctx

  Parameters

  • eventName: string

  • eventHandler: WithThisType<((...args) => boolean | void), unknown extends Ctx
        ? Render2dType
        : Ctx>

  • Optional context: Ctx

  Returns this

refresh

• refresh(): void

• Mark and repaint the canvas in the next frame of browser

  Returns void

refreshHover

• refreshHover(): void

• Refresh hover in next frame

  Returns void

refreshHoverImmediately

• refreshHoverImmediately(): void

• Refresh hover immediately

  Returns void

refreshImmediately

• refreshImmediately(fromInside?): void

• Repaint the canvas immediately

  Parameters

  • Optional fromInside: boolean

  Returns void

remove

• remove(el): void

• 删除元素

  Parameters

  • el: Element<ElementProps>

  Returns void

resize

• resize(opts?): void

• Resize the canvas. Should be invoked when container size is changed

  Parameters

  • Optional opts: {
        height?: string | number;
        width?: string | number;
    }

    • Optional height?: string | number

    • Optional width?: string | number

  Returns void

setBackgroundColor

• setBackgroundColor(backgroundColor): void

• Set background color

  Parameters

  • backgroundColor: string | GradientObject | PatternObject

  Returns void

setCursorStyle

• setCursorStyle(cursorStyle): void

• Set default cursor

  Parameters

  • cursorStyle: string

  Returns void

setDarkMode

• setDarkMode(darkMode): void

• Force to set dark mode

  Parameters

  • darkMode: boolean

  Returns void

setSleepAfterStill

• setSleepAfterStill(stillFramesCount): void

• Set sleep after still for frames. Disable auto sleep when it's 0.

  Parameters

  • stillFramesCount: number

  Returns void

trigger

• trigger(eventName, event?): void

• Trigger event manually

  Parameters

  • eventName: string

    Event name

  • Optional event: unknown

    Event object

  Returns void

wakeUp

• wakeUp(): void

• Wake up animation loop. But not render.

  Returns void