Interface GradientPickerArgs

The arguments for the GradientPicker constructor.

interface GradientPickerArgs {
    binding?: BindingBase;
    channels?: number;
    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) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    parent?: Element;
    readOnly?: boolean;
    renderChanges?: boolean;
    style?: string;
    tabIndex?: number;
    value?: number[];
    width?: number;
}

Hierarchy (view full)

Properties

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

Properties

Optional binding

binding?: BindingBase

A binding to use with this Element.

Optional channels

channels?: number

Number of color channels. Defaults to 3. Changing to 4 adds the option to change the alpha value.

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 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 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, the picker will render changes to the gradient as they happen. Defaults to true.

Optional style

style?: string

Sets an initial value for Element.dom.style.

Optional tabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optional value

value?: number[]

An array of 4 integers containing the RGBA values the picker should be initialized to.

Optional width

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

Theme

On This Page

bindingchannelsclassdomenablederrorheighthiddenidignoreParentisRootlinkonChangeonClickonRemoveparentreadOnlyrenderChangesstyletabIndexvaluewidth