ColorSampler

Represents a ColorSampler object in the Photoshop DOM.

ColorSamplers are created through the ColorSamplers collection via the ColorSamplers.add method:

Copy
const app = require("photoshop").app;
app.activeDocument.colorSamplers.add({x: 100, y: 100});
Copied to your clipboard
const app = require("photoshop").app;
app.activeDocument.colorSamplers.add({x: 100, y: 100});

Properties such as color, position and parent document can be then accessed on the ColorSampler instance:

Copy
let cs = app.activeDocument.colorSamplers[0];
console.log(cs.position);  // {x: 100, y: 100}
console.log(cs.color.rgb); // SolidColor {red: 0, green: 255, blue: 0}
console.log(cs.parent);    // Document
Copied to your clipboard
let cs = app.activeDocument.colorSamplers[0];
console.log(cs.position);  // {x: 100, y: 100}
console.log(cs.color.rgb); // SolidColor {red: 0, green: 255, blue: 0}
console.log(cs.parent);    // Document

An existing ColorSampler instance can be moved to a different position:

Copy
cs.move({x: 200, y: 200});
console.log(cs.position);  // {x: 200, y: 200}
Copied to your clipboard
cs.move({x: 200, y: 200});
console.log(cs.position);  // {x: 200, y: 200}

Or removed altogether from the document:

Copy
cs.remove();
console.log(app.activeDocument.colorSamplers.length); // 0
Copied to your clipboard
cs.remove();
console.log(app.activeDocument.colorSamplers.length); // 0

Properties

Methods

move

void

Moves the ColorSampler object to the given position

Parameters

remove

void

Deletes the given ColorSampler object.