Interface VectorInputArgs

The arguments for the VectorInput constructor.

interface VectorInputArgs {
    binding?: BindingBase;
    class?: string | string[];
    dimensions?: number;
    dom?: string | HTMLElement;
    enabled?: boolean;
    error?: boolean;
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    max?: number;
    min?: number;
    onChange?: ((value: any) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    parent?: Element;
    placeholder?: string;
    precision?: number;
    readOnly?: boolean;
    renderChanges?: boolean;
    step?: number;
    stepPrecision?: number;
    style?: string;
    tabIndex?: number;
    value?: any;
    values?: any[];
    width?: number;
}

Hierarchy (view full)

  • ElementArgs
  • IPlaceholderArgs
  • IBindableArgs
    • VectorInputArgs

Properties

binding? class? dimensions? dom? enabled? error? height? hidden? id? ignoreParent? isRoot? link? max? min? onChange? onClick? onRemove? parent? placeholder? precision? readOnly? renderChanges? step? stepPrecision? style? tabIndex? value? values? width?

Properties

Optionalbinding

binding?: BindingBase

A binding to use with this Element.

Optionalclass

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optionaldimensions

dimensions?: number

The number of dimensions in the vector. Can be between 2 to 4. Defaults to 3.

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.

Optionalmax

max?: number

The maximum value of each vector element.

Optionalmin

min?: number

The minimum value of each vector 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.

Optionalplaceholder

placeholder?: string

Sets the placeholder label that appears on the right of the input.

Optionalprecision

precision?: number

The decimal precision of each vector element. Defaults to 7.

OptionalreadOnly

readOnly?: boolean

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

OptionalrenderChanges

renderChanges?: boolean

If true each input will flash on changes.

Optionalstep

step?: number

The incremental step when using arrow keys or dragger for each vector element.

OptionalstepPrecision

stepPrecision?: number

The incremental step when holding Shift and using arrow keys or dragger for each vector element.

Optionalstyle

style?: string

Sets an initial value for Element.dom.style.

OptionaltabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optionalvalue

value?: any

Sets the value of the Element.

Optionalvalues

values?: any[]

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

Optionalwidth

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

On This Page

Properties