Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ColorPicker
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/ColorPicker"], function(ColorPicker) { /* code goes here */ });
Description
(Added at v3.13)
A widget to assist choosing a color from a color palette.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ColorPicker(params, srcNodeRef) | Creates a new ColorPicker widget. |
CSS
esri/dijit/ColorPicker | Download source
Properties
| Name | Type | Summary |
|---|---|---|
| collapsed | Boolean | Indicates whether the widget displays collapsed. |
| collapsible | Boolean | Indicates whether the widget is collapsible. |
| color | Color | The selected color. |
| palette | Color[] | The set of available color options. |
| recentColors | Color[] | An array of recent colors to show in the recent colors row. |
Methods
| Name | Return type | Summary |
|---|---|---|
| startup() | None | Finalizes the creation of the widget. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| color-change | Fires when the selected color has changed. |
Constructor Details
Creates a new
ColorPicker widget.Parameters:
< |
Required | Set of parameters used to specify the ColorPicker widget options. |
< |
Required | Reference or ID of the HTMLElement where the widget should be rendered. |
params properties: < |
Optional | Indicates whether the widget displays collapsed. Default value is false. |
< |
Optional | Indicates whether the widget can be collapsed. Default value is false. |
< |
Required | The selected color. If no color is provided, the first color from the palette is selected by default. |
< |
Optional | The row size of the palette. Default is 13. |
< |
Optional | The set of available color options. By default, a palette of 78 colors is provided. |
< |
Optional | Array of recent colors to show in the recent colors row. |
< |
Optional | Toggles color selection being required. When false, the no-color swatch is available. Default is false. |
< |
Optional | Toggles the recent color row. Default is true. |
< |
Optional | Toggles the transparency slider. Default is true. |
Sample:
require(["esri/dijit/ColorPicker", ...
], function(ColorPicker, ... ) {
var colorPicker = new ColorPicker(params, srcNodeRef);
...
});
Property Details
<Boolean
BooleanIndicates whether the widget displays collapsed. (Added at v3.22)
Default value:
false<Boolean
BooleanIndicates whether the widget is collapsible. (Added at v3.22)
Default value:
false<Color
ColorThe selected color.
<Color[]
Color[]The set of available color options.
<Color[]
Color[]An array of recent colors to show in the recent colors row.
Method Details
Event Details
[ On Style Events | Connect Style Event ]