Solid Color

Represents a color, and allows for mapping into all available Photoshop color models. Import SolidColor from the Photoshop's app object:

const SolidColor = require("photoshop").app.SolidColor;
Copied to your clipboard
const SolidColor = require("photoshop").app.SolidColor;

When a property is accessed (either via read or write), the current color model of the SolidColor objects gets set to the space of the accessor. Photoshop internally converts the color across these color spaces using the Color Settings set by the user.

For example, to set the foreground color to red:

const SolidColor = require("photoshop").app.SolidColor;
const red = new SolidColor();
red.rgb.red = 255;
red.rgb.green = 0;
red.rgb.blue = 0;

app.foregroundColor = red;
Copied to your clipboard
1const SolidColor = require("photoshop").app.SolidColor;
2const red = new SolidColor();
3red.rgb.red = 255;
4red.rgb.green = 0;
5red.rgb.blue = 0;
6
7app.foregroundColor = red;

To understand how color models change as you interact with a SolidColor object, please see example below:

const SolidColor = require("photoshop").app.SolidColor;
const c = new SolidColor();
console.log(c.base.typename); // By default, this will be "RGBColor"

c.cmyk.cyan = 50; // Photoshop will convert the color to CMYK using Edit > Color Settings data
console.log(c.base.typename); // Now, the typename will be "CMYKColor"

c.rgb.green = 128; // Typename will change back to "RGBColor"

Copied to your clipboard
1const SolidColor = require("photoshop").app.SolidColor;
2const c = new SolidColor();
3console.log(c.base.typename); // By default, this will be "RGBColor"
4
5c.cmyk.cyan = 50; // Photoshop will convert the color to CMYK using Edit > Color Settings data
6console.log(c.base.typename); // Now, the typename will be "CMYKColor"
7
8c.rgb.green = 128; // Typename will change back to "RGBColor"
9

Fixes in Photoshop 24.2:

Adds range validation for all color modes and its components so it should not be possible to enter invalid value.

Constructors

constructor

23.0

SolidColor

All colors default to pure white.

const SolidColor = require("photoshop").app.SolidColor;
const color = new SolidColor();
Copied to your clipboard
1const SolidColor = require("photoshop").app.SolidColor;
2const color = new SolidColor();

Parameters

Name	Type	Description
`model?`	ColorModel	Color model to start.

Properties

Name	Type	Access	Min Version	Description
cmyk	CMYKColor	R W	23.0	The color's representation in CMYK color space.
gray	GrayColor	R W	23.0	The color's representation in grayscale.
hsb	HSBColor	R W	23.0	The color's representation in HSB color space.
lab	LabColor	R W	23.0	The color's representation in LAB color space.
nearestWebColor	RGBColor	R	23.0	The color's nearest match within the 216 web-safe colors.
rgb	RGBColor	R W	23.0	The color's representation in RGB color space.
typename	string	R	24.2	The class name of the referenced object: "SolidColor".

Methods

isEqual

23.0

boolean

True if the SolidColor object is visually equivalent to the specified color.

Both colors are converted to Lab colorspace, and the sum of their normalized squared Euclidian distance in each space is averaged across the three then compared to a small constant (3.5e-6).

Due to differences in coverage by various color spaces and clamping, a color that is converted from RGB to CMYK and back may not be visually equal.