Skip to content

solid_color

A color definition used in the document.

Maps a color to equivalents in all available color models.

  • Used in Application.backgroundColor and foregroundColor properties, in Channel.color, in ColorSampler.color, and in TextItem.color
  • Passed to PathItem.fillPath(), Selection.fill(), and Selection.stroke().

SolidColor

Bases: Photoshop

A color definition used in the document.

Source code in photoshop/api/solid_color.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
class SolidColor(Photoshop):
    """A color definition used in the document."""

    object_name = "SolidColor"

    def __init__(self, parent=None):
        super().__init__(parent=parent)
        self._flag_as_method(
            "isEqual",
        )

    @property
    def cmyk(self) -> CMYKColor:
        """The CMYK color mode.

        Returns:
            .colors.cmyk.CMYKColor:

        """
        return CMYKColor(self.app.cmyk)

    @cmyk.setter
    def cmyk(self, value: CMYKColor):
        self.app.cmyk = value

    @property
    def gray(self) -> GrayColor:
        return GrayColor(self.app.gray)

    @property
    def hsb(self) -> HSBColor:
        return HSBColor(self.app.hsb)

    @hsb.setter
    def hsb(self, value: HSBColor):
        self.app.hsb = value

    @property
    def lab(self) -> LabColor:
        return LabColor(self.app.lab)

    @lab.setter
    def lab(self, value: LabColor):
        self.app.lab = value

    @property
    def model(self) -> ColorModel:
        """The color model."""
        return ColorModel(self.app.model)

    @model.setter
    def model(self, value: ColorModel):
        """The color model."""
        self.app.model = value

    @property
    def nearestWebColor(self) -> RGBColor:
        """The nearest web color to the current color."""
        return RGBColor(self.app.NearestWebColor)

    @property
    def rgb(self) -> RGBColor:
        """The RGB color mode."""
        return RGBColor(self.app.rgb)

    @rgb.setter
    def rgb(self, value: RGBColor):
        self.app.rgb = value

    def isEqual(self, color: RGBColor):
        """`SolidColor` object is visually equal to the specified color."""
        return self.app.isEqual(color)

cmyk: CMYKColor property writable

The CMYK color mode.

Returns:

Type Description
CMYKColor

.colors.cmyk.CMYKColor:

model: ColorModel property writable

The color model.

nearestWebColor: RGBColor property

The nearest web color to the current color.

rgb: RGBColor property writable

The RGB color mode.

isEqual(color)

SolidColor object is visually equal to the specified color.

Source code in photoshop/api/solid_color.py 
90
91
92
def isEqual(self, color: RGBColor):
    """`SolidColor` object is visually equal to the specified color."""
    return self.app.isEqual(color)
Last update: 2024-11-17
Created: 2024-11-17