Interface ArrayInputArgs

The arguments for the ArrayInput constructor.

interface ArrayInputArgs {
    binding?: BindingBase;
    class?: string | string[];
    dom?: string | HTMLElement;
    elementArgs?: any[];
    enabled?: boolean;
    error?: boolean;
    fixedSize?: boolean;
    getDefaultFn?: (() => any);
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    onChange?: ((value) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    parent?: Element;
    readOnly?: boolean;
    renderChanges?: boolean;
    style?: string;
    tabIndex?: number;
    type?: "string" | "number" | "boolean" | "vec2" | "vec3" | "vec4";
    usePanels?: boolean;
    value?: any;
    values?: any[];
    width?: number;
}

Hierarchy (view full)

Properties

binding? class? dom? elementArgs? enabled? error? fixedSize? getDefaultFn? height? hidden? id? ignoreParent? isRoot? link? onChange? onClick? onRemove? parent? readOnly? renderChanges? style? tabIndex? type? usePanels? value? values? width?

Properties

Optional binding

binding?: BindingBase

A binding to use with this Element.

Optional class

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optional dom

dom?: string | HTMLElement

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

Optional elementArgs

elementArgs?: any[]

Arguments for each array Element.

Optional enabled

enabled?: boolean

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

Optional error

error?: boolean

Sets whether the Element is in an error state.

Optional fixedSize

fixedSize?: boolean

If true then editing the number of elements that the array has will not be allowed.

Optional getDefaultFn

getDefaultFn?: (() => any)

Used to specify the default values for each element in the array. Defaults to null.

Type declaration

    • (): any

    • Returns any

Optional height

height?: number

Sets the initial height of the Element.

Optional hidden

hidden?: boolean

Sets whether this Element is hidden. Defaults to false.

Optional id

id?: string

The id attribute of this Element's HTMLElement.

Optional ignoreParent

ignoreParent?: boolean

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

Optional isRoot

isRoot?: boolean

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

Optional link

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

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

Type declaration

  • observer: Observer | Observer[]
  • path: string | string[]

Optional onChange

onChange?: ((value) => void)

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

Type declaration

    • (value): void

    • Parameters

      • value: any

      Returns void

Optional onClick

onClick?: (() => void)

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

Type declaration

    • (): void

    • Returns void

Optional onRemove

onRemove?: (() => void)

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

Type declaration

    • (): void

    • Returns void

Optional parent

parent?: Element

Sets the parent Element.

Optional readOnly

readOnly?: boolean

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

Optional renderChanges

renderChanges?: boolean

If true each input will flash on changes.

Optional style

style?: string

Sets an initial value for Element.dom.style.

Optional tabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optional type

type?: "string" | "number" | "boolean" | "vec2" | "vec3" | "vec4"

The type of values that the array can hold. Can be one of the following:

  • boolean
  • number
  • string
  • vec2
  • vec3
  • vec4

Defaults to string.

Optional usePanels

usePanels?: boolean

If true then the array will be rendered using panels. Defaults to false.

Optional value

value?: any

Sets the value of the Element.

Optional values

values?: any[]

Sets multiple values to the Element. It is up to the Element to determine how to display them.

Optional width

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

Theme

On This Page

bindingclassdomelementArgsenablederrorfixedSizegetDefaultFnheighthiddenidignoreParentisRootlinkonChangeonClickonRemoveparentreadOnlyrenderChangesstyletabIndextypeusePanelsvaluevalueswidth