TrophyCustomer's Canvas is honored with a 2020 InterTech Technology Award! Learn more 

IColorPickerConfigParsed Interface

A structure defining the Color picker. For details, see the Color Picker topic.

configuration = {
    widgets: {
        ColorPicker: {
            colorSpace: "rgb",
            sections: [
                type: "NoColorSection",
                targets: [ "Fill", "Border", "Background" ]
                type: "RecentSection",
                translationKey: "ColorPicker.RECENT_SECTION_NAME"
                type: "PaletteSection",
                translationKey: "Swatches",
                viewType: "Line",
                palette: [["rgb(0, 0, 0)","rgb(255, 255, 255)"],
                          ["rgb(255, 0, 0)","rgb(255, 255, 0)","rgb(0, 255, 0)","rgb(0, 255, 255)","rgb(0, 0, 255)","rgb(255, 0, 255)"]]


Optional availableColorSpaces

availableColorSpaces: ColorSpaceType []

Obsolete. Specifies the color spaces that will be available to your users in the Color picker. The default value is ["rgb", "cmyk"].

Optional colorSpace

colorSpace: ColorSpaceType

Defines the color space which the user can select a swatch from. The default value is "rgb".

Optional defaultColorSpace

defaultColorSpace: ColorSpaceType

Deprecated, define the required color space in the colorSpace property. The default value is "rgb".

Optional palette

palette: string [] []

Deprecated, define a palette in the corresponding section . Palette to show in color picker; a palette is defined by a two-dimensional array of colors in a css-compatible format. The default value is [["rgb(0, 0, 0)","rgb(67, 67, 67)",...],...].

Optional sectionCollapseEnabled

sectionCollapseEnabled: boolean

If true, allows users to collapse the sections of predefined palettes when they click headers of these sections in the Color picker. The default value is false.


A set of predefined palettes.

Optional showPaletteOnly

showPaletteOnly: boolean

If true, shows the predefined palettes and hides the color field in the Color picker. If false, shows both the predefined palettes and the field. The default value is false.