# Appearance - Effect Properties
# General Effect Properties
The following properties apply to all effects.
| Property | Description |
|---|---|
name | The name of the effect to be applied. Currently one must provide the name of the effect to be applied. Valid Values: convertToShape, cropMarks, dropShadow, feather, innerGlow, offset or offsetPath, outerGlow, outlineObject, outlineStroke, pathfinder, pucker puckerAndBloat or bloat, rasterize, roughen, roundCorners, scribble, transform, tweak, twist, warp, zigzag |
visible | Whether the effect is visible or not |
mode | The type of action to apply to the targeted effect Effect Modes for a description of each mode. Valid Values: add, addEdit, edit, remove, replace |
index | The index of the effect to be targeted Example Values: 1, 2, 3 |
# Effect Modes
For a more comprehensive understanding of modes see Modes
| Mode | Description |
|---|---|
add | Adds / inserts a new effect at the given index |
addEdit | Edits an existing effect, existing properties will be kept besides those explicitly changed. If the effect does not exist it will be added. This is the default mode. |
edit | Edits an existing effect, existing properties will be kept besides those explicitly changed. If the effect does not exist it will NOT be added. |
remove | Removes the targeted effect |
replace | Replaces all existing properties including effect from the targeted effect with newly provided properties |
# Convert to Shape
| Property | Description |
|---|---|
absolute 3 | Whether the width and height are absolute Example Values: true, false |
corner / cornerRadius 7 | The corner radius for rounded rectangles Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
height 6 | The height or extra height of the object Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
name | The name of the effect convertToShape |
relative 4 | Whether the width and height are relative Example Values: true, false absolute and relative are opposites |
shape 1 | The shape to convert to Example Values: rectangle or (1 re rect), roundedRectangle or (2 ro rounded), ellipse or (3 el circle) |
width 5 | The width or extra width of the object Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
# Crop Marks
| Property | Description |
|---|---|
name | The name of the effect cropMarks |
markType / printerMarkType | The type crop mark to use Roman like Illustrators UI or to Japanese mid crop marksExample Values: standard, roman, r, j, japanese |
# Distort & Transform
# Pucker & Bloat
| Property | Description |
|---|---|
bloat 1 | The plucker (negative numbers) or bloat (positive numbers) of the object Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
name | The name of the effect Valid values pucker puckerAndBloat or bloat(Synonyms) |
# Roughen
| Property | Description |
|---|---|
absolute 4 | Whether the deviation is an absolute measurement Example Values: true, false |
name | The name of the effect, roughen |
points 6 | Type of points Example Values: smooth, corner |
relative 3 | Whether the deviation is relative Example Values: true, false absolute and relative are opposites |
size 2 | The max deviation from the objects path Example Values: For absolute deviations 5mm, 10, 1" for relative deviations 10, 30 |
detail 5 | How many deviations to make per inch of the object's path Example Values: 4, 10 |
# Transform
| Property | Description |
|---|---|
anchorPoint 18 | The anchor point to scale, rotate or reflect from Valid Values: tl topLeft 1, t top 2, tr topRight 3l left 4, c center 5, r right 6bl bottomLeft 7, b bottom 8, br bottomRight 9 |
angle 11 | Degrees to rotate the object Valid Values: 0, -50, 360 etc. |
copies 19 | Number of copies of the original object Valid Values: 0, 10 etc. |
horizontalMove, moveH 9 | Distance to move horizontally Valid Values: 10in, 2000, 1' etc. |
horizontalScale, scaleH 7 | Percentage to scale horizontally Valid Values: 1, 200 |
name | The name of the effect, transform |
random 17 | Whether to randomize the effects Example Values: true, false |
reflectX, reflectH 15 | Whether to reflect along the X axis Example Values: true, false |
reflectY, reflectV 16 | Whether to reflect along the Y axis Example Values: true, false |
scaleStrokes 14 | Whether to transform the strokes and effects Example Values: true, false |
transformObjects 12 | Whether to transform the objects (and not just the patterns) Example Values: true, false |
transformPatterns 13 | Whether to transform the patterns Example Values: true, false |
verticalMove, moveV 10 | Distance to move vertically Valid Values: 10in, 2000, 1' etc. |
verticalScale, scaleV 8 | Percentage to scale vertically Valid Values: 1, 200 |
# Tweak
| Property | Description |
|---|---|
absolute 23 | Whether the width and height are absolute Example Values: true, false |
horizontal 20 | The horizontal tweak as a percent or measurement Valid Values: For relative 0, 100For Absolute 3, 1mm, .5" etc. |
modifyAnchor 24 | Whether to modify the anchor points Example Values: true, false |
modifyIn 25 | Whether to modify the in control points Example Values: true, false |
modifyOut 26 | Whether to modify the out control points Example Values: true, false |
name | The name of the effect, tweak |
relative 22 | Whether the width and height are relative Example Values: true, false |
vertical 21 | The vertical tweak as a percent or measurement Valid Values: For relative 0, 100For Absolute 3, 1mm, .5" etc. |
# Twist
| Property | Description |
|---|---|
angle 27 | The twist angle Valid values: 0, 123, 360 etc. |
name | The name of the effect, twist |
# Zigzag
| Property | Description |
|---|---|
absolute 30 | Whether the width and height are absolute Example Values: true, false |
name | The name of the effect, zigzag |
points 32 | Type of points Example Values: smooth, corner /> |
relative 29 | Whether the width and height are relative Example Values: true, false absolute and relative are opposites |
ridges 31 | The number of ridges per segment Valid values: 1, 3, 4 etc. |
size 28 | The deviation from the objects path Example Values: For absolute deviations 5mm, 10, 1" for relative deviations 10, 30 |
# Path
# Offset Path
| Property | Description |
|---|---|
offset 1 | The distance to offset the path Valid Values: -2mm, 10, 2p3 etc. |
join / joins 2 | The join type Example Values: miter, round or bevel |
miterLimit 3 | The miter limit to use for miter type joins Valid Values: 1, 2, 3 etc. |
name | The name of the effect, offset or offsetPath |
# Outline Object
| Property | Description |
|---|---|
name | The name of the effect, outlineObject |
# Outline Stroke
| Property | Description |
|---|---|
name | The name of the effect, outlineStroke |
# Pathfinder
| Property | Description |
|---|---|
heightWidth 4 | The trap height/width ratio, only applicable for the trap operation Valid Values: 10, 50, 90 etc. |
mixingRate 2 | The mixing rate, only applicable for the soft mix operation Valid Values: 10, 50, 90 etc. |
name | The name of the effect, pathfinder |
operation 1 | The pathfinder operation (command) to apply Example Values: add, intersect, exclude, subtract, minusBack, divide, trim, merge, crop, outline, hardMix, softMix or trap |
precision 8 | The precision in points, only applicable for the trap operation Valid Values: .2, .01" |
removeRedundantPoints 9 | Whether to remove redundant points, only applicable for the trap operation Valid Values: true or false |
removeUnpaintedArtwork 10 | Whether divide and outline, only applicable for the divide and outline operations Valid Values: true or false |
reverseTraps 7 | Whether to reverse the trap, only applicable for the trap operation Valid Values: true or false |
thickness 3 | The trap thickness, only applicable for the trap operation Valid Values: 10, 50, 90 etc. |
tintReduction 5 | The trap tint reduction, only applicable for the trap operation Valid Values: 10, 50, 90 etc. |
trapsWithProcessColor 6 | Whether to trap with process color, only applicable for the trap operation Valid Values: true or false |
# Rasterize
| Property | Description |
|---|---|
colorModel 1 | The color model of the raster effect Example Values: cmyk, rgb, grayScale gray, bitmap or document Due to a bug in Illustrator, a color model must always be provided. If no color model is provided, the document's current color model will be used. |
resolution / dpi 2 ppi 4 | The resolution of the raster effect in ppi Valid Values: 72, 150, 300, 4, 123 etc. Due to a bug in Illustrator, a resolution must always be provided. If no resolution is provided, the resolution will be set to 72. |
background 3 | The background to apply to the raster effect Example Values: white, transparent, true, false |
useDocumentResolution / documentDPI 5 | Whether to use the document's raster effect resolution Example Values: true, false |
antiAliasing / antialias 6 | The type of anti-aliasing to apply to the raster effect Example Values: none false, art true or type |
mask / createClippingMask 7 | Whether to create a clipping mask Example Values: true, false |
addAround / addAroundObject / padding 8 | The amount of padding to add around the objects Example Values: 10, 10pt, .5" etc. |
name | The name of the effect, rasterize |
# Stylize
# Drop Shadow
| Property | Description |
|---|---|
blendMode 1 | The blend mode to apply to the effect Example Values: normal, multiply, screen, overlay, softLight soft, hardLight hard, colorDodge dodge, colorBurn burn, darken, lighten, difference, exclusion, hue, saturation, color, luminosity |
opacity 2 | The opacity of the drop shadow Valid Values: 15, 30, 78 etc. |
xOffset / horizontal / h 3 | The horizontal offset of the shadow Valid Values: -5, .25", 1mm etc. When applying a new dropshadow, a value must be provided for both horizontal and vertical offsets. |
yOffset / vertical / v 4 | The vertical offset of the shadow Valid Values: -5, .25", 1mm etc. |
blur 5 | The blur to apply to the shadow Valid Values: 5, .25", 1mm etc. |
color 6 | The color of the shadow Valid Values: None, red, strawberryJam, #0f0, #C0FFEE, #BEEFED, #FACADE, #D1FFER, #DECADE, #BEADED, cmyk(100, 0, 0, 0), cmyk(50 100 0 0), rgb(255 128 0), gray(45), lab(100, -128, 127), swatch('My Case Sensitive Swatch Name') etc. Provide one of color or darkness, not both |
darkness 7 | Percentage darkness to apply to the shadow Valid Values: 0, 5, 50, 100 etc. |
name | The name of the effect, dropShadow |
Effect Colors 🎨
All the color properties that are described in the Colors and Swatches 🎨 sections can be used with effect colors.
For example
#, swatch colorMode, swatchName, etc.
# Feather
| Property | Description |
|---|---|
radius 8 | The feather radius Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
name | The name of the effect, feather |
# Inner Glow
| Property | Description |
|---|---|
blendMode 9 | The blend mode to apply to the effect Example Values: normal, multiply, screen, overlay, softLight soft, hardLight hard, colorDodge dodge, colorBurn burn, darken, lighten, difference, exclusion, hue, saturation, color, luminosity |
opacity 11 | The opacity of the glow Valid Values: 15, 30, 78 etc. |
blur 12 | The blur to apply to the glow Valid Values: 5, .25", 1mm etc. |
color 10 | The color of the glow Valid Values: None, red, strawberryJam, #0f0, #C0FFEE, #BEEFED, #FACADE, #D1FFER, #DECADE, #BEADED, cmyk(100, 0, 0, 0), cmyk(50 100 0 0), rgb(255 128 0), gray(45), lab(100, -128, 127), swatch('My Case Sensitive Swatch Name') etc. Provide one of color or darkness, not both |
fromEdge 13 | Whether to apply the glow from the object's edge Valid Values: true or false |
name | The name of the effect, innerGlow |
Effect Colors 🎨
All the color properties that are described in the Colors and Swatches 🎨 sections can be used with effect colors.
For example
#, swatch colorMode, swatchName, etc.
# Outer Glow
| Property | Description |
|---|---|
blendMode 14 | The blend mode to apply to the effect Example Values: normal, multiply, screen, overlay, softLight soft, hardLight hard, colorDodge dodge, colorBurn burn, darken, lighten, difference, exclusion, hue, saturation, color, luminosity |
opacity 16 | The opacity of the glow Valid Values: 15, 30, 78 etc. |
blur 17 | The blur to apply to the glow Valid Values: 5, .25", 1mm etc. |
color 15 | The color of the glow Valid Values: None, red, strawberryJam, #0f0, #C0FFEE, #BEEFED, #FACADE, #D1FFER, #DECADE, #BEADED, cmyk(100, 0, 0, 0), cmyk(50 100 0 0), rgb(255 128 0), gray(45), lab(100, -128, 127), swatch('My Case Sensitive Swatch Name') etc. Provide one of color or darkness, not both |
name | The name of the effect, outerGlow |
Effect Colors 🎨
All the color properties that are described in the Colors and Swatches sections can be used with effect colors.
For example
#, swatch colorMode, swatchName, etc.
# Round Corners
| Property | Description |
|---|---|
radius 18 | The radius to apply to the corners Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
name | The name of the effect, roundCorners |
# Scribble
| Property | Description |
|---|---|
angle 20 | The angle of the scribble lines Valid Values: -50, 100, 264 etc. |
pathOverlap / overlap 21 | How much the scribble lines should overlap Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
pathOverlapVariation / overlapVariation 22 | The variation that to apply to the overlap Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
strokeWidth 23 | The stroke width to use for the scribble Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
curviness 24 | The curviness to use for the scribble Valid Values: 3, 40, 100 etc. |
curvinessVariation 25 | The variation that to apply to the curviness Valid Values: 3, 40, 100 etc. |
spacing 26 | The spacing to use for the scribble Valid Values: valid measurements, 2 (Points) 1" 1in 2.5mm etc. |
spacingVariation 27 | The variation that to apply to the scribble Valid Values: 3, 40, 100 etc. |
name | The name of the effect, scribble |
# Warp
| Property | Description |
|---|---|
style 1 | The warp style to apply Example Values: arc, arcLower, arcUpper, arch, bulge, shellLower, shellUpper, flag, wave, fish, rise, fishEye, inflate, squeeze, twist |
isVertical 2 | Whether the warp should be applied vertically Example Values: true or false |
direction 2 | The direction the warp should be applied Example Values: horizontal or vertical |
bend 3 | The percentage bend to apply Valid Values: -50, |
horizontal 4 | The percentage horizontal distortion to apply Valid Values: -50, |
vertical 5 | The percentage vertical distortion to apply Valid Values: -50, |
name | The name of the effect, warp |
# Blur
This applies the Photoshop Gaussian Blur effect to the object.
Note: Currently, the only Photoshop effect supported by Darty is the Gaussian Blur effect, no other Photoshop effects including the radial and smart blurs are supported.
| Property | Description |
|---|---|
name | The name of the effect blur |
blur | The amount of blur to apply to the object |
# Example Effects Spreadsheets
# Effect applied to the entire object with out specifying that the effect is a post effect
| cat | |||
| appearance | |||
| effect[1]name: dropShadow | effect[1]blur | effect[1]color | effect[1]xOffset |
| Effect to apply to the cat | |||
| dropShadow | 3mm | red | 5 |
| outerGlow | 3mm | blue |
# Effect applied to the entire object specifying that the effect is a post effect
| cat | |||
| appearance | |||
| postEffect[1]name: dropShadow | postEffect[1]blur | postEffect[1]color | effect[1]xOffset |
| Effect to apply to the cat | |||
| dropShadow | 3mm | red | 5 |
| outerGlow | 3mm | blue |
# Effect to the object's top level stroke
| cat | |||
| appearance | |||
| stroke[1]effect[1]name: dropShadow | stroke[1]effect[1]blur | stroke[1]effect[1]color | effect[1]xOffset |
| Effect to apply to the cat | |||
| dropShadow | 3mm | red | 5 |
| outerGlow | 3mm | blue |