Adobe 12040118 Using Help - Page 143

Property removeKey() method, Enumerated Types, Description

Page 143 highlights

Help Using Help Reference Back 143 The enumerated type associated with this attribute has one value for each type of data that can be stored in and/or retrieved from a property. All property objects store data that falls into one of these categories. Each type of data is stored and retrieved in a different kind of structure. For example, a 3D spatial property (like a layer's position) is stored as an array of three floating point values. When setting a value for position, you'd pass in such an array, as in: my layer.proper t y("position").setValue([10,20,0]); For another example, a shape property (such as a layer's mask shape) is stored as a Shape object. When setting a value for a shape, pass in a shape object, as in: var myShape = new Shape(); myShape.vertices = [[0,0],[0,100],[100,100],[100,0]]; var myMask = mylayer.property("ADBE Mask Parade").property(1); myMa s k . p rop e r t y ( " A D B E Ma s k S h a p e " ) . s e t Va l u e ( my S h a p e ) ; Enumerated Types Proper t yValueTy p e.NO_VALUE Proper t yValueTy p e.ThreeD_SPATIAL Proper t yValueTy p e.ThreeD Proper t y ValueTy p e.TwoD_SPATIAL Proper t y Va lueTy p e.Two D Proper t yValueTy p e.OneD Proper t yValueTy p e.COLOR Proper t y ValueTy p e.CUSTOM_VALUE Proper t yValueTy p e.MARKER Proper t yValueTy p e.LAYER_INDEX Proper t yValueTy p e.MASK_INDEX Proper t yValueTy p e.SHAPE Proper t yValueTy p e.TEXT_D O CUMENT stores no data array of three floating point positional values, e.g., Anchor Pont [10, 20.2, 0] array of three floating point quantitative values, e.g., Scale [100, 20.2, 0] array of 2 floating point positional values, e.g., Anchor Pont [5.1, 10] array of 2 floating point quantitative values, e.g., Scale [5.1, 100] a floating point value array of 4 floating point values in the range 0..1, e.g., [.8, .3, .1, 1.0] unimplemented type; you cannot get and set values for properties with this type MarkerValue object (see "MarkerValue object" on page 114) integer; a value of 0 means none (no layer) integer; a value of 0 means none (no mask) shape object TextDocument object (see "TextDocument object" on page 177) Property removeKey() method app.project.item(index).layer(index).property(name).removeKey(keyIndex) Description The property removeKey method removes a keyframe with the given keyIndex. If no keyframe with that keyIndex exists, this method generates an exception and an error is displayed. Using Help Back 143

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 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
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253

U
sing H
elp
B
ack
143
Help
Reference
U
sing H
elp
B
ack
143
The enumerated type associated with this attribute has one value for each type of data that can be stored in
and/or retrieved from a property. All property objects store data that falls into one of these categories.
Each type of data is stored and retrieved in a different kind of structure. For example, a 3D spatial property
(like a layer's position) is stored as an array of three floating point values. When setting a value for position,
you'd pass in such an array, as in:
mylayer.property("position").setValue([10,20,0]);
For another example, a shape property (such as a layer's mask shape) is stored as a Shape object. When setting
a value for a shape, pass in a shape object, as in:
var myShape = new Shape();
myShape.vertices = [[0,0],[0,100],[100,100],[100,0]];
var myMask = mylayer.property("ADBE Mask Parade").property(1);
myMask.property("ADBE Mask Shape").setValue(myShape);
Enumerated Types
Property removeKey() method
app.project.item(index).layer(index)
.
property(name)
.removeKey(
keyIndex
)
Description
The property removeKey method removes a keyframe with the given keyIndex. If no keyframe with that
keyIndex exists, this method generates an exception and an error is displayed.
PropertyValueType.NO_VALUE
stores no data
PropertyValueType.ThreeD_SPATIAL
array of three floating point positional values, e.g., Anchor
Pont [10, 20.2, 0]
PropertyValueType.ThreeD
array of three floating point quantitative values, e.g., Scale
[100, 20.2, 0]
PropertyValueType.TwoD_SPATIAL
array of 2 floating point positional values, e.g., Anchor Pont
[5.1, 10]
PropertyValueType.TwoD
array of 2 floating point quantitative values, e.g., Scale [5.1,
100]
PropertyValueType.OneD
a floating point value
PropertyValueType.COLOR
array of 4 floating point values in the range 0..1, e.g., [.8, .3, .1,
1.0]
PropertyValueType.CUSTOM_VALUE
unimplemented type; you cannot get and set values for
properties with this type
PropertyValueType.MARKER
MarkerValue object (see “MarkerValue object” on page 114)
PropertyValueType.LAYER_INDEX
integer; a value of 0 means none (no layer)
PropertyValueType.MASK_INDEX
integer; a value of 0 means none (no mask)
PropertyValueType.SHAPE
shape object
PropertyValueType.TEXT_DOCUMENT
TextDocument object (see “TextDocument object” on
page 177)