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 6.15.0, 6.x (may differ) · Archived documentation

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

example
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)"]]
              }
            ]
        }
    }
};

Properties

Optional colorSpace

colorSpace: ColorSpaceType

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

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.

sections

sections: IColorPickerConfigSection []

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.