Interface CanvasArgs

The arguments for the Canvas constructor.

interface CanvasArgs {
    binding?: BindingBase;
    class?: string | string[];
    dom?: string | HTMLElement;
    enabled?: boolean;
    error?: boolean;
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    onChange?: ((value: any) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    parent?: Element;
    readOnly?: boolean;
    style?: string;
    tabIndex?: number;
    useDevicePixelRatio?: boolean;
    width?: number;
}

Hierarchy (view full)

Properties

binding? class? dom? enabled? error? height? hidden? id? ignoreParent? isRoot? link? onChange? onClick? onRemove? parent? readOnly? style? tabIndex? useDevicePixelRatio? width?

Properties

Optionalbinding

binding?: BindingBase

A binding to use with this Element.

Optionalclass

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optionaldom

dom?: string | HTMLElement

The HTMLElement to create this Element with. If not provided this Element will create one.

Optionalenabled

enabled?: boolean

Sets whether it is possible to interact with this Element and its children.

Optionalerror

error?: boolean

Sets whether the Element is in an error state.

Optionalheight

height?: number

Sets the initial height of the Element.

Optionalhidden

hidden?: boolean

Sets whether this Element is hidden. Defaults to false.

Optionalid

id?: string

The id attribute of this Element's HTMLElement.

OptionalignoreParent

ignoreParent?: boolean

If true, this Element will ignore its parent's enabled value when determining whether this element is enabled. Defaults to false.

OptionalisRoot

isRoot?: boolean

Sets whether this Element is at the root of the hierarchy.

Optionallink

link?: {
    observer: Observer | Observer[];
    path: string | string[];
}

Links the observer attribute at the path location in the given observer to this Element.

OptionalonChange

onChange?: ((value: any) => void)

If provided and the Element is changeable, this function will be called each time the element value is changed.

OptionalonClick

onClick?: (() => void)

If provided and the Element is clickable, this function will be called each time the element is clicked.

OptionalonRemove

onRemove?: (() => void)

If provided and the Element is removable, this function will be called each time the element is removed.

Optionalparent

parent?: Element

Sets the parent Element.

OptionalreadOnly

readOnly?: boolean

Whether this Element is read only or not. Defaults to false.

Optionalstyle

style?: string

Sets an initial value for Element.dom.style.

OptionaltabIndex

tabIndex?: number

Sets the tabIndex of the Element.

OptionaluseDevicePixelRatio

useDevicePixelRatio?: boolean

Whether the canvas should use the devicePixelRatio. Defaults to false.

Optionalwidth

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

On This Page

Properties