Skip to main content

getProperties()

returns an object with the available configuration attributes of the control

getProperties(): IColorpickerProps;

Returns:

An object with the available attributes of the control and their values.

Example

var form = new dhx.Form("form_container", {    rows: [        {            type: "colorpicker",            name: "colorpicker",            labelWidth: "200px",            label: "Choose your color"        }    ]});
form.getItem("colorpicker").getProperties();
// -> the returned object:{    customColors: [],    editable: false,    errorMessage: "",    grayShades: true,    height: "content",    helpMessage: "",    hiddenLabel: false,    icon: "",    label: "Choose your color",    labelPosition: "top",    labelWidth: "200px",    padding: 0,    palette: [Array(7), Array(7), ...],    placeholder: "",    preMessage: "",    required: false,    successMessage: "",    validation: undefined,    width: "content"}

The returned object of the ColorPicker control can contain the following configuration attributes:

validation(function) the validation function, takes as a parameter the value to validate and returns true/false to indicate the result of validation
width(string|number|"content") the width of a control
height(string|number|"content") the height of a control
padding(string|number) sets padding between a cell and a border of the ColorPicker control
icon(string) the name of an icon from the used icon font
placeholder(string) a tip for the input
editable(boolean) allows a user to enter the value of the control manually
required(boolean) defines whether a control is required
label(string) specifies a label for a control
labelWidth(string|number) sets the width of the label of a control
hiddenLabel(boolean) invisible label that will be used to identify the input on the server side
labelPosition(string) defines the position of a label: "left"|"top"
helpMessage(string) adds a help message to a control
preMessage(string) a message that contains instructions for interacting with the control
successMessage(string) a message that appears in case of successful validation of the control value
errorMessage(string) a message that appears in case of error during validation of the control value
mode(string) the mode of a control: "palette" (default), "picker"
palette(array) contains arrays of colors you want to be shown in a colorpicker
customColors(array) shows a section with custom colors in the bottom part of the ColorPicker
grayShades(boolean) defines whether the section with gray shades is displayed in the palette

Change log:

added in v7.0