Home » Adobe Manuals » Computer Software » Adobe 19400084 » Manual Viewer

Adobe 19400084 Scripting Guide - Page 143

PathItem, Document, SubPathItem, SubPathItems

UPC - 883919081830

View all Adobe 19400084 manuals

Add to My Manuals
Save this manual to your list of manuals

Page 143 highlights

JavaScript Scripting Reference Adobe Photoshop CS3 JavaScript Object Reference 143 PathItems The collection of pathItem objects in the document. See PathItem for information on pathItem objects. Note: Because the PathItems class is a property of the Document object, you use the property name, pathItems, rather than the class name, PathItems, in your code. For example: var myPathItem = docRef.pathItems.add("A Line", lineSubPathArray) The following sample uses the PathItems object incorrectly: var myPathItem = docRef.PathItems.add("A Line", lineSubPathArray) Properties Property length parent typename Value Type What it is number (long) Read-only. The number of pathItem objects in the pathItems collection. object (document) Read-only. The pathItems object's container. string Read-only. The class name of the referenced pathItems object. Methods Method index (itemKey) add (name, entirePath) getByName (name) removeAll () Parameter Type number string array of SubPathInfo objects string Returns What it does PathItem Gets a pathItem object from the pathItems collection. PathItem Creates a new PathItem object from the sub paths defined in the array provided in the entirePath parameter. A new SubPathItem object is created for each SubPathInfo object provided in entirePath, and those SubPathItem objects are added to the SubPathItems collection of the returned PathItem. PathItem Get the first element in the pathItems collection with the provided name. Removes all pathItem objects from the pathItems collection.

Section	Page
Contents	3
Introduction	31
JavaScript support in Adobe Photoshop CS3	31
Executing scripts	31
Installing scripts	32
Executing other scripts	32
Startup scripts	32
Changes Since Earlier Versions	32
JavaScript Object Reference	35
Working with the Properties Tables	35
displayDialogs	35
Working with the Methods Tables	35
executeAction	36
Working with Method Parameters	36
ActionDescriptor	37
Properties	37
count	37
typename	37
Methods	37
clear	37
erase	37
fromStream	37
getBoolean	37
getClass	37
getData	37
getDouble	37
getEnumerationType	37
getEnumerationValue	37
getInteger	37
getKey	37
getList	37
getObjectType	38
getObjectValue	38
getPath	38
getReference	38
getString	38
getType	38
getUnitDoubleType	38
getUnitDoubleValue	38
hasKey	38
isEqual	38
putBoolean	38
putClass	38
putData	38
putDouble	38
putEnumerated	38
putInteger	38
putList	39
putObject	39
putPath	39
putReference	39
putString	39
putUnitDouble	39
toStream	39
ActionList	40
Properties	40
count	40
typename	40
Methods	40
clear	40
getBoolean	40
getClass	40
getData	40
getDouble	40
getEnumerationType	40
getEnumerationValue	40
getInteger	40
getList	40
getObjectType	40
getObjectValue	41
getPath	41
getReference	41
getString	41
getType	41
getUnitDoubleType	41
getUnitDoubleValue	41
putBoolean	41
putClass	41
putData	41
putDouble	41
putEnumerated	41
putInteger	41
putList	41
putObject	41
putPath	41
putReference	42
putString	42
putUnitDouble	42
ActionReference	43
Properties	43
typename	43
Methods	43
getContainer	43
getDesiredClass	43
getEnumeratedType	43
getEnumeratedValue	43
getForm	43
getIdentifier	43
getIndex	43
getName	43
getOffset	43
getProperty	43
putClass	43
putEnumerated	44
putIdentifier	44
putIndex	44
putName	44
putOffset	44
putProperty	44
Application	45
Properties	45
activeDocument	45
backgroundColor	45
colorSettings	45
displayDialogs	45
documents	45
fonts	45
foregroundColor	45
freeMemory	45
locale	45
macintoshFileTypes	45
measurementLog	45
name	46
notifiers	46
notifiersEnabled	46
path	46
playbackDisplayDialogs	46
playbackParameters	46
preferences	46
preferencesFolder	46
recentFiles	46
scriptingBuildDate	46
scriptingVersion	46
typename	46
version	46
windowsFileTypes	46
Methods	47
batch	47
beep	47
bringToFront	47
charIDToTypeID	47
doAction	47
eraseCustomOptions	47
executeAction	47
executeActionGet	47
featureEnabled	48
getCustomOptions	48
load	48
makeContactSheet	48
makePDFPresentation	48
makePhotoGallery	48
makePhotomerge	48
makePicturePackage	48
open	49
openDialog	49
purge	49
putCustomOptions	49
refresh	49
stringIDToTypeID	49
typeIDToCharID	50
typeIDToStringID	50
ArtLayer	53
Properties	53
allLocked	53
blendMode	53
bounds	53
fillOpacity	53
grouped	53
isBackgroundLayer	53
kind	53
linkedLayers	54
name	54
opacity	54
parent	54
pixelsLocked	54
positionLocked	54
textItem	54
transparentPixelsLocked	54
typename	54
visible	54
Methods	54
adjustBrightnessContrast	54
adjustColorBalance	54
adjustCurves	55
adjustLevels	55
applyAddNoise	55
applyAverage	55
applyBlur	55
applyBlurMore	55
applyClouds	55
applyCustomFilter	55
applyDeInterlace	55
applyDespeckle	55
applyDifferenceClouds	55
applyDiffuseGlow	55
applyDisplace	56
applyDustAndScratches	56
applyGaussianBlur	56
applyGlassEffect	56
applyHighPass	56
applyLensBlur	57
applyLensFlare	57
applyMaximum	58
applyMedianNoise	58
applyMinimum	58
applyMotionBlur	58
applyNTSC	58
applyOceanRipple	58
applyOffset	58
applyPinch	58
applyPolarCoordinates	58
applyRadialBlur	58
applyRipple	58
applySharpen	58
applySharpenEdges	59
applySharpenMore	59
applyShear	59
applySmartBlur	59
applySpherize	59
applyStyle	59
applyTextureFill	59
applyTwirl	59
applyUnSharpMask	59
applyWave	59
applyZigZag	60
autoContrast	60
autoLevels	60
clear	60
copy	60
cut	60
desaturate	60
duplicate	60
equalize	60
invert	60
link	60
merge	61
mixChannels	61
move	61
photoFilter	62
posterize	62
rasterize	62
remove	62
resize	62
rotate	62
selectiveColor	62
shadowHighlight	62
threshold	63
translate	63
unlink	63
ArtLayers	65
Properties	65
length	65
parent	65
typename	65
Methods	65
index	65
add	65
getByName	65
removeAll	65
BatchOptions	66
Properties	66
destination	66
destinationFolder	66
errorFile	66
fileNaming	66
macintoshCompatible	66
overrideOpen	66
overrideSave	67
startingSerial	67
suppressOpen	67
suppressProfile	67
typename	67
unixCompatible	67
windowsCompatible	67
BitmapConversionOptions	68
Properties	68
angle	68
frequency	68
method	68
patternName	68
resolution	68
shape	68
typename	68
BMPSaveOptions	69
Properties	69
alphaChannels	69
depth	69
flipRowOrder	69
osType	69
rleCompression	69
typename	69
CameraRAWOpenOptions	70
Properties	70
bitsPerChannel	70
blueHue	70
blueSaturation	70
brightness	70
chromaticAberrationBY	70
chromaticAberrationRC	70
colorNoiseReduction	70
colorSpace	70
contrast	70
exposure	70
greenHue	70
greenSaturation	70
luminanceSmoothing	70
redHue	70
redSaturation	70
resolution	70
saturation	70
settings	70
shadows	70
shadowTint	71
sharpness	71
size	71
temperature	71
tint	71
typename	71
vignettingAmount	71
vignettingMidpoint	71
whiteBalance	71
Channel	72
Properties	72
color	72
histogram	72
kind	72
name	72
opacity	72
parent	72
typename	73
visible	73
Methods	73
duplicate	73
merge	73
remove	73
Channels	74
Properties	74
length	74
parent	74
typename	74
Methods	74
index	74
add	74
getByName	74
removeAll	74
CMYKColor	79
Properties	79
black	79
cyan	79
magenta	79
typename	79
yellow	79
ColorSampler	80
Properties	80
color	80
position	80
parent	80
typename	80
Methods	80
move	80
remove	80
ColorSamplers	81
Properties	81
length	81
parent	81
typename	81
Methods	81
index	81
add	81
getByName	81
removeAll	81
ContactSheetOptions	82
Properties	82
acrossFirst	82
bestFit	82
caption	82
columnCount	82
flatten	82
font	82
fontSize	82
height	82
horizontal	82
mode	82
resolution	82
rowCount	82
typename	82
useAutoSpacing	82
vertical	83
width	83
CountItem	84
Properties	84
position	84
parent	84
typename	84
Methods	84
remove	84
CountItems	85
Properties	85
length	85
parent	85
typename	85
Methods	85
index	85
add	85
getByName	85
removeAll	85
DCS1_SaveOptions	86
Properties	86
dCS	86
embedColorProfile	86
encoding	86
halftoneScreen	86
interpolation	86
preview	86
transferFunction	86
typename	86
vectorData	86
DCS2_SaveOptions	87
Properties	87
dCS	87
embedColorProfile	87
encoding	87
halftoneScreen	87
interpolation	87
multiFileDCS	87
preview	87
spotColors	87
transferFunction	87
typename	87
vectorData	87
DICOMOpenOptions	88
Properties	88
anonymize	88
columns	88
reverse	88
rows	88
showOverlays	88
typename	88
windowLevel	88
windowWidth	88
Document	89
Properties	89
activeChannels	89
activeHistoryBrushSource	89
activeHistoryState	89
activeLayer	89
artLayers	89
backgroundLayer	89
bitsPerChannel	89
channels	89
colorProfileName	89
colorProfileType	89
colorSamplers	90
componentChannels	90
countItems	90
fullName	90
height	90
histogram	90
historyStates	90
info	90
layerComps	90
layers	90
layerSets	90
managed	90
measurementScale	90
mode	90
name	90
parent	91
path	91
pathItems	91
pixelAspectRatio	91
quickMaskMode	91
resolution	91
saved	91
selection	91
typename	91
width	91
xmpMetadata	91
Methods	92
autoCount	92
changeMode	92
close	92
convertProfile	92
crop	93
duplicate	93
exportDocument	93
flatten	93
flipCanvas	93
importAnnotations	93
mergeVisibleLayers	93
paste	94
print	94
rasterizeAllLayers	94
recordMeasurements	94
resizeCanvas	94
resizeImage	94
revealAll	95
rotateCanvas	95
save	95
saveAs	95

Match case Limit results 1 per page

Adobe Photoshop CS3

JavaScript Scripting Reference

JavaScript Object Reference

143

PathItems

The collection of

pathItem

objects in the document. See

PathItem

for information on

pathItem

objects.

Note:

Because the

PathItems

class is a property of the

Document

object, you use the property name,

pathItems

, rather than the class name,

PathItems

, in your code. For example:

var myPathItem = docRef.pathItems.add(“A Line”, lineSubPathArray)

The following sample uses the

PathItems

object incorrectly:

var myPathItem = docRef.PathItems.add(“A Line”, lineSubPathArray)

Properties

Methods

Property

Value Type

What it is

length

number (long)

Read-only. The number of

pathItem

objects in the

pathItems

collection.

parent

object (document)

Read-only. The

pathItems

object's container.

typename

string

Read-only. The class name of the referenced

pathItems

object.

Method

Parameter Type

Returns

What it does

index

(itemKey)

number

PathItem

Gets a

pathItem

object from the

pathItems

collection.

add

(name,

entirePath)

string

array of

SubPathInfo

objects

PathItem

Creates a new

PathItem

object from the sub

paths defined in the array provided in the

entirePath

parameter.

A new

SubPathItem

object is created for

each

SubPathInfo

object provided in

entirePath

, and those

SubPathItem

objects are added to the

SubPathItems

collection of the returned

PathItem

getByName

(name)

string

PathItem

Get the first element in the

pathItems

collection with the provided name.

removeAll

()

Removes all

pathItem

objects from the

pathItems

collection.