Class EventAbstract

The whole Event. Contain an EventBody and an EventMark, maybe has a EventAxis too. The Manage-Component. All of draw is resolved by child component.

Hierarchy

Constructors

constructor

Properties

axis axisConstructor body bodyConstructor canvas container destroyed drawInfo element? ext extraData grid mark markConstructor name ratio theme

Accessors

l

Methods

apply checkDestroy createBox createElement destroy draw hide importDrawInfo initAxis initBody initMark setupRadio is

Constructors

constructor

Properties

axis

axis: null | EventAxis = null

Abstract axisConstructor

axisConstructor: typeof EventAxis

body

body: EventBody = ...

Abstract bodyConstructor

bodyConstructor: typeof EventBody

canvas

canvas: HTMLCanvasElement

The canvas where component draw on.

container

container: HTMLElement

The container which contain all of component's element.

destroyed

destroyed: boolean = false

Means that the component has been destroyed. Call any method on component when it has destroyed will got an error.

drawInfo

drawInfo: DrawInfo

All info about draw. Except drawInfo, no more states be depended about draw. The same drawInfo must has same drawn on canvas and container. The this.gird should be merging in there in this.apply be called. Must can unscathed passed this.drawInfo = JSON.parse(JSON.stringify(this.drawInfo)).

Optional element

element?: HTMLElement

Optional. Be filled in this.createElement. The HTML element which be needed by component draw.

ext

ext: ExtensionManager

Manage all extensions & Help component communicate for each other.

extraData

extraData: ExtraData = {}

An ext extra

See

ExtraData

grid

grid: GridConfig

mark

mark: EventMark = ...

Abstract markConstructor

markConstructor: typeof EventMark

name

name: SN = SN.Event

Component name. Be filled when the engine's class constructed.

ratio

ratio: number = ...

A ratio for draw, it's using when draw on High DPI display

Abstract theme

theme: string

Theme name. Be filled when the theme's class constructed.

Accessors

Protected l

  • get l(): ((stringArr: TemplateStringsArray, ...values: any[]) => void)

  • Print log if the DEBUG is true.

    Example

    this.lHello world

    Returns ((stringArr: TemplateStringsArray, ...values: any[]) => void)

      • (stringArr: TemplateStringsArray, ...values: any[]): void

      • Parameters

        • stringArr: TemplateStringsArray
        • Rest ...values: any[]

        Returns void

Methods

apply

  • Apply this.drawInfo in component. This method should't change any property in this.drawInfo except this.drawInfo.box.

    Async

    Returns Promise<MustCallAndReturnSuperMethod>

Protected checkDestroy

createBox

  • Create a box object to fill this.drawInfo.box. It should be called in apply() at least once. Write this method if you need to change the behavior about box.

    Returns void

createElement

  • Optional. Depend on the draw this component is need HTML element or not. Create an HTML element base on this.drawInfo to fill this.element and append to this.container. Be called in this.apply and this.draw.

    Returns MustCallAndReturnSuperMethod

destroy

  • Destroy self. It should remove all element from dom and clear all trace in canvas if that's made by self.

    Returns MustCallAndReturnSuperMethod

draw

  • Draw self base on this.drawInfo. It should can be call multiple times. Call this.apply before this.draw.

    Returns MustCallAndReturnSuperMethod

hide

  • Hide all of trace created by self. Hidden is not destroyed. Ensure the component is still available when this.hide have call. This method will try set "visibility: 'hidden'" for this.element rather than remove it.

    Returns MustCallAndReturnSuperMethod

importDrawInfo

initAxis

initBody

initMark

setupRadio

Static is

Settings

Member Visibility

Theme

Generated using TypeDoc