CountItems
A collections class allowing access to the document's CountItem.
Properties
| Name | Type | Access | Min Version | Description |
|---|---|---|---|---|
length | number | R | 24.1 | Number of CountItem elements in this collection. |
parent | R | 24.1 | The owner Document of this CountItems collection. | |
typename | string | R | 24.1 | The CountItems collection's typename. |
Methods
activateGroupByIndex
24.1void
Activates a Count Item group by its index.
Parameters
| Name | Type |
|---|---|
index | number |
add
24.1Adds a new CountItem to the collection.
Copied to your clipboardapp.activeDocument.countItems.add({x: 20, y: 20});
Parameters
| Name | Type |
|---|---|
position | object |
position.x | number |
position.y | number |
createGroup
24.1void
Creates a new Count Item group.
Parameters
| Name | Type |
|---|---|
groupName | string |
getAll
24.1Retrieves all CountItem objects from this collection.
Copied to your clipboardapp.activeDocument.countItems.getAll();
removeAllFromActiveGroup
24.1void
Clears all CountItem objects from this collection.
Copied to your clipboardapp.activeDocument.countItems.removeAllFromActiveGroup();
removeGroupByIndex
24.1void
Removes a Count Item group by its index.
Parameters
| Name | Type |
|---|---|
index | number |
renameActiveGroup
24.1void
Renames the currently active Count Item group.
Parameters
| Name | Type |
|---|---|
groupName | string |
setActiveColor
24.1void
Sets the Color of the Count Item marker and label.
Parameters
| Name | Type |
|---|---|
color |
setActiveLabelSize
24.1void
Sets the Count Item label (the number) size.
Parameters
| Name | Type |
|---|---|
size | number |
setActiveMarkerSize
24.1void
Sets the Count Item marker (the dot) size.
Parameters
| Name | Type |
|---|---|
size | number |
toggleActiveGroupVisibility
24.1void
Toggles the visibility of the currently selected Count Item group.
Parameters
| Name | Type |
|---|---|
isVisible | boolean |