Class Ctx2D<StaticProps, ChangeableProps, CallbacksTypes>

Makes working with canvas easier. It creates an HTML5 Canvas element and its 2d context and can implement automatic resize.

Type Parameters

StaticProps extends NCtx2D.IStaticProps = NCtx2D.IStaticProps
ChangeableProps extends NCtx2D.IChangeableProps = NCtx2D.IChangeableProps
CallbacksTypes extends NCtx2D.ICallbacksTypes = NCtx2D.ICallbacksTypes

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- Ctx2D
  - Ctx2DPrerender

Index

Constructors

constructor

new Ctx2D<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?, canInit?): Ctx2D<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NCtx2D.IStaticProps = NCtx2D.IStaticProps
- ChangeableProps extends NCtx2D.IChangeableProps = NCtx2D.IChangeableProps
- CallbacksTypes extends NCtx2D.ICallbacksTypes = NCtx2D.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
- canInit: boolean = true
Returns Ctx2D<StaticProps, ChangeableProps, CallbacksTypes>
Overrides Component.constructor
- Defined in src/components/Ctx2D/index.ts:92

Properties

`Protected` _canvas

_canvas: HTMLCanvasElement

The Canvas element itself

`Protected` _ctx

_ctx: CanvasRenderingContext2D

2D Context

`Protected` _dpr

_dpr: number

Device pixel ratio

`Protected` _height

_height: number

`Protected` _width

_width: number

Accessors

app

get app(): Application
Vevet Application

Returns Application
Inherited from ComponentClass.app
- Defined in src/base/Module/index.ts:68

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

Returns Callbacks<CallbacksTypes>
Inherited from ComponentClass.callbacks
- Defined in src/base/Module/index.ts:47

canRender

get canRender(): boolean
If content may be successfully rendered

Returns boolean
- Defined in src/components/Ctx2D/index.ts:88

canvas

get canvas(): HTMLCanvasElement
The Canvas element itself

Returns HTMLCanvasElement
- Defined in src/components/Ctx2D/index.ts:41

clientHeight

get clientHeight(): number
Returns number
- Defined in src/components/Ctx2D/index.ts:75

clientWidth

get clientWidth(): number
Returns number
- Defined in src/components/Ctx2D/index.ts:62

container

get container(): false | Element
The parent element of the canvas

Returns false | Element
- Defined in src/components/Ctx2D/index.ts:33

ctx

get ctx(): CanvasRenderingContext2D
2D Context

Returns CanvasRenderingContext2D
- Defined in src/components/Ctx2D/index.ts:49

dpr

get dpr(): number
Device pixel ratio

Returns number
- Defined in src/components/Ctx2D/index.ts:83

height

get height(): number
Returns number
- Defined in src/components/Ctx2D/index.ts:70

isDestroyed

get isDestroyed(): boolean
The module is destroyed

Returns boolean
Inherited from ComponentClass.isDestroyed
- Defined in src/base/Module/index.ts:94

isInitialized

get isInitialized(): boolean
The module is initialized

Returns boolean
Inherited from ComponentClass.isInitialized
- Defined in src/base/Module/index.ts:86

name

get name(): string
Module name

Returns string
Inherited from ComponentClass.name
- Defined in src/base/Module/index.ts:73

prefix

get prefix(): string
Module prefix

Returns string
Inherited from ComponentClass.prefix
- Defined in src/base/Module/index.ts:78

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
Current properties

Returns TRequiredModuleProp<StaticProps & ChangeableProps>
Inherited from ComponentClass.props
- Defined in src/base/Module/index.ts:34

width

get width(): number
Returns number
- Defined in src/components/Ctx2D/index.ts:57

Methods

`Protected` _destroy

_destroy(): void
Destroy the component

Returns void
Inherited from Component._destroy
- Defined in src/base/Component/index.ts:39

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    container: boolean;
    dpr: string;
    hasInitialResize: boolean;
    hasResize: boolean;
    height: string;
    resizeDebounce: number;
    shouldAppend: boolean;
    viewportTarget: string;
    width: string;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    container: boolean;
    dpr: string;
    hasInitialResize: boolean;
    hasResize: boolean;
    height: string;
    resizeDebounce: number;
    shouldAppend: boolean;
    viewportTarget: string;
    width: string;
}
Overrides Component._getDefaultProps
- Defined in src/components/Ctx2D/index.ts:17

`Protected` _handleResize

_handleResize(): void
Method called on resize

Returns void
- Defined in src/components/Ctx2D/index.ts:210

`Protected` _init

_init(): void
Inner extra initialization

Returns void
Overrides Component._init
- Defined in src/components/Ctx2D/index.ts:131

`Protected` _onPropsMutate

_onPropsMutate(): void
This method is called on properties change

Returns void
Overrides Component._onPropsMutate
- Defined in src/components/Ctx2D/index.ts:125

`Protected` _setResize

_setResize(): void
Set resize events

Returns void
- Defined in src/components/Ctx2D/index.ts:138

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Add a module callback
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
- action: TAction<CallbacksTypes[T]>
- settings: ISettings = {}
Returns IAddedCallback
Inherited from Component.addCallback
- Defined in src/base/Module/index.ts:245

`Protected` addDestroyableAction

addDestroyableAction(action): void
Add destroyable actions
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from Component.addDestroyableAction
- Defined in src/base/Module/index.ts:224

addEventListener

addEventListener<El, Target, Callback>(el, target, callback, options?): IAddEventListener
Add a DOM event listener
Type Parameters
- El extends ListenerElement
- Target extends keyof HTMLElementEventMap
- Callback extends ((evt) => void)
Parameters
- el: El
- target: Target
- callback: Callback
- Optional options: IAddEventListenerOptions
Returns IAddEventListener
Inherited from Component.addEventListener
- Defined in src/base/Module/index.ts:254

addPlugin

addPlugin<T>(plugin): void
Add a single plugin
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
Returns void
Inherited from Component.addPlugin
- Defined in src/base/Component/index.ts:21

addResponsiveProps

addResponsiveProps(rules): void
Add responsive rules
Parameters
- rules: IResponsive<ChangeableProps>
Returns void
Inherited from Component.addResponsiveProps
- Defined in src/base/Module/index.ts:173

addViewportCallback

addViewportCallback(target, action, data?): void
Add a viewport callback that will be removed on class destroy
Parameters
- target: keyof NViewport.ICallbacksTypes
- action: ((arg) => void)
  - - (arg): void
    - Parameters
      
      arg: IChanges
      
      Returns void
- data: undefined | ISettings = {}
Returns void
Inherited from Component.addViewportCallback
- Defined in src/base/Module/index.ts:231

changeProps

changeProps(props): void
Change module properties
Parameters
- props: Partial<ChangeableProps>
Returns void
Inherited from Component.changeProps
- Defined in src/base/Module/index.ts:184

`Protected` className

className(...classNames): string
Parameters
- Rest ...classNames: string[]
Returns string
Inherited from Component.className
- Defined in src/base/Module/index.ts:279

destroy

destroy(): void
Destroy the module

Returns void
Inherited from Component.destroy
- Defined in src/base/Module/index.ts:299

init

init(): void
Initializes the class

Returns void
Inherited from Component.init
- Defined in src/base/Module/index.ts:202

render

render(renderProp): void
Render the scene if possible
Parameters
- renderProp: TRender
Returns void
- Defined in src/components/Ctx2D/index.ts:213

resize

resize(): void
Resize the canvas

Returns void
- Defined in src/components/Ctx2D/index.ts:161

`Protected` toggleClassName

toggleClassName(element, className, isActive): void
Toggle classList
Parameters
- element: Element
- className: string
- isActive: boolean
Returns void
Inherited from Component.toggleClassName
- Defined in src/base/Module/index.ts:284

Class Ctx2D<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NCtx2D.IStaticProps = NCtx2D.IStaticProps

ChangeableProps extends NCtx2D.IChangeableProps = NCtx2D.IChangeableProps

CallbacksTypes extends NCtx2D.ICallbacksTypes = NCtx2D.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NCtx2D.IStaticProps = NCtx2D.IStaticProps

ChangeableProps extends NCtx2D.IChangeableProps = NCtx2D.IChangeableProps

CallbacksTypes extends NCtx2D.ICallbacksTypes = NCtx2D.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns Ctx2D<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected _canvas

Protected _ctx

Protected _dpr

Protected _height

Protected _width

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

canRender

Returns boolean

canvas

Returns HTMLCanvasElement

clientHeight

Returns number

clientWidth

Returns number

container

Returns false | Element

ctx

Returns CanvasRenderingContext2D

dpr

Returns number

height

Returns number

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

width

Returns number

Methods

Protected _destroy

Returns void

Protected _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & { container: boolean; dpr: string; hasInitialResize: boolean; hasResize: boolean; height: string; resizeDebounce: number; shouldAppend: boolean; viewportTarget: string; width: string; }

Protected _handleResize

Returns void

Protected _init

Returns void

Protected _onPropsMutate

Returns void

Protected _setResize

Returns void

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` _canvas

`Protected` _ctx

`Protected` _dpr

`Protected` _height

`Protected` _width

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
container: boolean;
dpr: string;
hasInitialResize: boolean;
hasResize: boolean;
height: string;
resizeDebounce: number;
shouldAppend: boolean;
viewportTarget: string;
width: string;
}

`Protected` _handleResize

`Protected` _init

`Protected` _onPropsMutate

`Protected` _setResize

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]

`Protected` toggleClassName