View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IColorPickerConfigParsed Interface

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

The color picker providing color selection in the editor. For details, see the Colors topic.

example
configuration = {
    widgets: {
        ColorPicker: {
            showPaletteOnly: true,
            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)"]]
        }
    }
};

Properties

Optional availableColorSpaces

availableColorSpaces: ColorSpaceType []

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

Optional defaultColorSpace

defaultColorSpace: ColorSpaceType

Defines the default color space. The default value is "rgb".

Optional palette

palette: string [] []

Palette to show in color picker; a palette is described by the two-dimensional array: array of palettes, where each palette is an array of colors in css-compatible format. The default value is [["rgb(0, 0, 0)","rgb(67, 67, 67)",...],...].

Optional showPaletteOnly

showPaletteOnly: boolean

Shows only the palette specified via the palette parameter in the color picker. The default value is false.