Object

ArtLayer

An object within a document that contains the visual elements of the image (equivalent to a layer in the Adobe Photoshop application).

Layer ›ArtLayer

Properties

Type	Access	Description
Number	read/write	The interior opacity of the layer. Range: 0.0 to 100.0.
Number	read/write	The density of the filter mask (between 0.0 and 100.0)
Number	read/write	The feather of the filter mask (between 0.0 and 250.0)
Boolean	read/write	If true, the layer is grouped with the layer below.
Boolean	read/write	If true, the layer is a background layer.
LayerKind +12 more	read/write	Sets the layer kind (such as 'text layer') for an empty layer. Valid only when the layer is empty and when 'is background layer ' is false. You can use the 'kind ' property to make a background layer a normal layer; however, to make a layer a background layer, you must set 'is background layer' to true.
Number	read/write	The density of the layer mask (between 0.0 and 100.0)
Number	read/write	The feather of the layer mask (between 0.0 and 250.0)
The	readonly	The object's container.
Boolean	read/write	If true, the pixels in the layer's image cannot be edited.
Boolean	read/write	If true, the pixels in the layer's image cannot be moved within the layer.
TextItem	readonly	The text that is associated with the layer. Valid only when 'kind' is text layer.
Boolean	read/write	If true, editing is confined to the opaque portions of the layer.
String	readonly	The class name of the object.
Number	read/write	The density of the vector mask (between 0.0 and 100.0)
Number	read/write	The feather of the vector mask (between 0.0 and 250.0)

Methods

→ ArtLayer

Adds an element.

→ void

Adjusts the brightness and constrast.

brightness Int The brightness amount. Range: -100 to 100.

contrast Int The contrast amount. Range: -100 to 100.

→ void

Adjusts the color balance of the layer's component channels.

shadows? Int[] The adjustments for the shadows. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.

midtones? Int[] The adjustments for the midtones. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.

highlights? Int[] The adjustments for the highlights. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.

preserveLuminosity? Boolean If true, luminosity is preserved.

→ void

Adjusts the tonal range of the selected channel using up to fourteen points.

curveShape Point[] The curve points. The number of points must be between 2 and 14.

→ void

Adjusts levels of the selected channels.

inputRangeStart Int 0–253 The input levels minimum. Range: 0 to 253.

inputRangeEnd Int The input levels maximum. Range: (input range start + 2) to 253.

inputRangeGamma Number The input levels gamma. Range: 0.10 to 9.99.

outputRangeStart Int 0–253 The output levels minimum. Range: 0 to 253.

outputRangeEnd Int The output levels maximum. Range: (output range start + 2) to 253.

→ void

Applies the add noise filter.

amount Number The amount of noise (as a percentage). Range: 0.1 to 400.0.

distribution NoiseDistribution The noise distribution type.

monochromatic Boolean If true, applies the filter only to the tonal elements in the image without changing the colors.

→ void

Applies the average filter.

→ void

Applies the blur filter.

→ void

Applies the blur more filter.

→ void

Applies the clouds filter.

→ void

Applies the custom filter.

characteristics Int[] The custom filter characteristics. This is an array of 25 values that corresponds to a left-to-right, top-to- bottom traversal of the array presented in the Custom dialog in the user interface (Filter > Other > Custom).

scale Int The value by which to divide the sum of the brightness values of the pixels included in the calculation.

offset Int The value to be added to the result of the scale calculation.

→ void

Applies the de-interlace filter.

eliminateFields EliminateFields The fields to eliminate.

createFields CreateFields The method to use to replace eliminated fields.

→ void

Applies the despeckle filter.

→ void

Applies the difference clouds filter.

→ void

Applies the diffuse glow filter.

graininess Int 0–10 The amount of graininess. Range: 0 to 10.

glowAmount Int 0–20 The glow amount. Range: 0 to 20.

clearAmount Int 0–20 The clear amount. Range: 0 to 20.

→ void

Applies the displace filter.

horizontalScale Int The amount of horizontal distortion. Range: -999 to 999.

verticalScale Int The amount of vertical distortion. Range: -999 to 999.

displacementType DisplacementMapType The displacement type.

undefinedAreas UndefinedAreas The treatment of undistorted areas.

displacementMapFile File The distortion image map.

→ void

Applies the dust and scratches filter.

radius Int 1–16 The size (in pixels) of the area searched for dissimilar pixels. Range: 1 to 16.

threshold Int 0–255 Determines how dissimilar the pixels should be before they are eliminated. Range: 0 to 255.

→ void

Applies the gaussian blur filter.

radius Number The blur width in pixels. Range: 1.0 to 250.0.

→ void

Applies the glass filter.

distortion Int 0–20 The amount of distortion. Range: 0 to 20.

smoothness Int 1–15 The smoothness. Range: 1 to 15.

scaling Int 50–200 The amount of scaling. Range: 50 to 200.

invert? Boolean If true, the texture is inverted.

texture? TextureType The type of texture.

textureFile? File The file from which to load the texture type.

→ void

Applies the high pass filter.

radius Number The width (in pixels) of the radius where edge details are retained.

→ void

Apply the lens blur filter.

source? DepthMapSource The source for the depth map.

focalDistance? Int The blur focal distance (in pixels) for the depth map. RangeL 0 to 255. Valid only when 'source' is transparency or layer mask.

invertDepthMap? Boolean If true, inverts the depth map.

shape? Geometry The shape of the iris.

radius? Int 0–100 The radius of the iris. Range: 0 to 100.

bladeCurvature? Int 0–100 The blade curvature of the iris. Range: 0 to 100.

rotation? Int 0–360 The rotation of the iris (in degrees). Range: 0 to 360.

brightness? Int 0–100 The brightness for the specular highlights. Range: 0 to 100.

threshold? Int 0–255 The threshold for the specular highlights. Range: 0 to 255.

amount? Int 0–100 The amount of noise. Range: 0 to 100.

distribution? NoiseDistribution The distribution value for the noise.

monochromatic? Boolean If true, the noise is monochromatic.

→ void

Applies the lens flare filter.

brightness Int 10–300 The flare brightness. Range: 10 to 300.

flareCenter UnitPoint The position of the flare center.

lensType LensType The lens type.

→ void

Applies the maximum filter.

radius Number 0–100 The choke area (in pixels). Range: 0 to 100.

→ void

Applies the median noise filter.

radius Number 0–100 The size of the area searched for pixels of similar brightness. Range: 0 to 100.

→ void

Applies the minimum filter.

radius Number 0–100 The spread area (in pixels). Range: 0 to 100.

→ void

Applies the motion blur filter.

angle Int The angle (in degrees). Range: -360 to 360.

radius Number 1–999 The radius (in pixels). Range: 1 to 999.

→ void

Applies the NTSC colors filter.

→ void

Applies the ocean ripple filter.

size Int 1–15 The ripple size. Range: 1 to 15.

magnitude Int 0–20 The ripple magnitude. Range: 0 to 20.

→ void

Applies the offset filter.

horizontal UnitValue The amount (in pixels) to move the selection horizontally (to the right). Range: -6144 to 6144.

vertical UnitValue The amount (in pixels) to move the selection vertically (downward). Range: -6144 to 6144.

undefinedAreas OffsetUndefinedAreas The method for filling areas left blank by the offset.

→ void

Applies the pinch filter.

amount Int The pinch amount. Range: -100 to 100.

→ void

Applies the polar coordinates filter.

conversion PolarConversionType The conversion type.

→ void

Applies the radial blur filter.

amount Int 1–100 The amount of blur. Range: 1 to 100.

blurMethod RadialBlurMethod The blur method to use.

blurQuality RadialBlurQuality The smoothness or graininess of the blurred image.

blurCenter? UnitPoint Position (unit value)

→ void

Applies the ripple filter.

amount Int The ripple amount. Range: -999 to 999.

size RippleSize The ripple size.

→ void

Applies the sharpen filter.

→ void

Applies the sharpen edges filter.

→ void

Applies the sharpen more filter.

→ void

Applies the shear filter.

curve Varies[] Specification of the shear curve in points as x,y coordinate pairs in the format [[x1, y1],[x2, y2]]. Any number of coordinate pairs can be specified.

undefinedAreas UndefinedAreas The treatment of areas left blank by the distortion.

→ void

Applies the smart blur filter.

radius Number The blur radius. Range: 0 - 1000.

threshold Number The blur threshold. Range: 0 - 1000.

blurQuality SmartBlurQuality The smoothness or graininess of the blurred image.

mode SmartBlurMode The smart blur mode.

→ void

Applies the spherize filter.

amount Int The amount of distortion. Range: -100 to 100.

mode SpherizeMode The distortion mode.

→ void

Applies the specified style to the layer.

styleName String The layer style to apply.

→ void

file File Style file to apply.

→ void

Applies the texture fill filter.

textureFile File The texture file. Must be a grayscale Photoshop file.

→ void

Applies the twirl filter.

angle Int The twirl angle. Range: -999 to 999.

→ void

Applies the unsharp mask filter.

amount Number 1–500 The amount of sharpening (as a percentage). Range: 1 to 500.

radius Number The radius in pixels. Range: 0.1 to 250.0.

threshold Int 0–255 The contrast threshold. Range: 0 to 255.

→ void

Applies the wave filter.

generatorNumber Int 1–999 The number of generators. Range: 1 to 999.

minimumWavelength Int 1–998 The minimum wave length. Range: 1 to 998.

maximumWavelength Int The maximum wave length. Range: 2 to (minimum wavelength + 1)

minimumAmplitude Int 1–998 The minimum amplitude. Range: 1 to 998.

maximumAmplitude Int The maximum amplitude. Range: 2 to (minimum amplitude + 1)

horizontalScale Int 1–100 The amount of horizontal scale (as a percentage). Range: 1 to 100.

verticalScale Int 1–100 The amount of vertical scale (as a percentage). Range: 1 to 100.

waveType WaveType The wave type.

undefinedAreas UndefinedAreas The treatment of areas left blank by the distortion.

randomSeed Int The random seed.

→ void

Applies the zigzag filter.

amount Int The amount of zigzag. Range: -100 to 100.

ridges Int The ridge length.

style ZigZagType The zigzag style.

→ void

Adjusts the contrast of the selected channels automatically.

→ void

Adjust the levels of the selected channels using the auto levels option.

→ void

Cuts the layer without moving it to the clipboard.

→ void

Copies the layer to the clipboard.

merge? Boolean If true, the copy includes all visible layers. If false, the copy only copies from the current layer.

→ void

Cuts the layer to the clipboard.

→ void

Converts a color image to a grayscale image in the current color mode by assigning equal values of each component color to each pixel.

→ void

Redistributes the brightness values of pixels in an image to more evenly represent the entire range of brightness levels within the image.

→ void

Inverts the colors in the layer by converting the brightness value of each pixel in the channels to the inverse value on the 256-step color-values scale.

→ ArtLayer

Merges the layer down, removing the layer from the document. Returns a reference to the art layer that this layer is merged into.

→ void

Modifies a targeted (output) color channel using a mix of the existing color channels in the image. (output channels = An array of channel specifications. For each component channel, specify a list of adjustment values (-200 to 200) followed by a 'constant' value (-200 to 200).) When monochrome = true, the maximum number of channel value specifications is 1. Valid only when 'document mode' = RGB or CMYK. RGB arrays must include four doubles. CMYK arrays must include five doubles.

outputChannels Varies[] A list of channel specifications. For each component channel that the document has, you must specify a list of adjustment values followed by a 'constant' value.

monochrome? Boolean If true, uses monochrome mixing. Note: If this is true, you can only specify one channel value.

→ void

Adjusts the layer's color balance and temperature as if a color filter had been applied.

fillColor? SolidColor The color to use for the fill.

density? Int 1–100 The density (as a percentage) of the filter effect. Range: 1 to 100.

preserveLuminosity? Boolean If true, luminosity is preserved.

→ void

Specifies the number of tonal levels for each channel and then maps pixels to the closest matching level.

levels Int 2–255 The tonal levels. Range: 2 to 255.

→ void

Converts the targeted content in the layer into a flat, raster image.

target RasterizeType What to rasterize.

→ void

file File File to save the style to.

thumbnail? File File to save the style thumbnail to.

thumbnailSize? Int Size of thumbnail to save.

backgroundValue? Number Background grayvalue.

→ void

selectionMethod AdjustmentReference Modifies the amount of a process color in a specified primary color without affecting the other primary colors.

reds? Number[] Array of 4 values: cyan, magenta, yellow, black.

yellows? Number[] Array of 4 values: cyan, magenta, yellow, black.

greens? Number[] Array of 4 values: cyan, magenta, yellow, black.

cyans? Number[] Array of 4 values: cyan, magenta, yellow, black.

blues? Number[] Array of 4 values: cyan, magenta, yellow, black.

magentas? Number[] Array of 4 values: cyan, magenta, yellow, black.

whites? Number[] Array of 4 values: cyan, magenta, yellow, black.

neutrals? Number[] Array of 4 values: cyan, magenta, yellow, black.

blacks? Number[] Array of 4 values: cyan, magenta, yellow, black.

→ void

Adjusts the range of tones in the shadows and highlights.

shadowAmount? Int 0–100 The shadow amount, as a percentage. Range: 0 to 100.

shadowWidth? Int 0–100 The shadow width, as a percentage. Range: 0 to 100 for tonal width (0 = narrow), (100 = broad).

shadowRaduis? Int 0–2500 The shadow radius (in pixels). Range: 0 to 2500.

highlightAmount? Int 0–100 The highlight amount, as a percentage. Range: 0 to 100.

highlightWidth? Int 0–100 The highlight width. Range: 0 to 100 for tonal width (0 = narrow), (100 = broad).

highlightRaduis? Int 0–2500 The highlight radius (in pixels). Range: 0 to 2500.

colorCorrection? Int The amount to adjust the colors in the changed portion of the image. Range: -100 to 100.

midtoneContrast? Int The amount of midtone contrast. Range: -100 to 100.

blackClip? Number Fractions of whites to be clipped. Range: 0.000 to 50.000.

whiteClip? Number Fractions of blacks to be clipped. Range: 0.000 to 50.000.

→ void

Converts grayscale or color images to high-contrast, B/W images by converting pixels lighter than the specified threshold to white and pixels darker than the threshold to black.

level Int The threshold level.

Object of 1

Properties elsewhere that hold a ArtLayer.

Document.backgroundLayer

Return 7

Methods that return a ArtLayer.

ArtLayer.add()ArtLayer.merge()ArtLayers.[]()ArtLayers.add()ArtLayers.getByName()Document.paste()LayerSet.merge()