Information Classification: External Restricted.
See https://www.chili-publish.com/security
Document Object Model - SnippetFrame
A frame containing another CHILI document / snippet.
Fields
Name | Type | Triggers | Description |
|---|---|---|---|
clippingPath |
| Applied clipping path | |
pageNum | int | Placed page number | |
numPages | int |
| amount of pages in the placed snippet document |
hasClippingPath | bool |
| Is a clipping path applied? |
hasContent | bool |
| If true, the frame contains a snippet |
path | string |
| snippet path |
previewURL | string |
| Preview URL for snippet (filled by editor, purely for display/reporting. Setting this property has no effect) |
realWidthPixels | int |
| Real snippet document width (regardless of scaling), in pixels |
realHeightPixels | int |
| Real snippet document height (regardless of scaling), in pixels |
realResolution | number |
| Not applicable for snippet frames |
realWidth | number |
| Real snippet document width (regardless of scaling) |
realHeight | number |
| Real snippet document height (regardless of scaling) |
fitMode | Fit mode | ||
fitPoint | Fit point, when applicable for fit mode | ||
imgX | unit | Placed X coordinate | |
imgY | unit | Placed Y coordinate | |
imgWidth | unit | Placed width | |
imgHeight | unit | Placed height | |
imgRotation | number | Placed rotation | |
clipX | unit |
| Clip X |
clipY | unit |
| Clip Y |
clipWidth | unit |
| Clip width |
clipHeight | unit |
| Clip height |
externalID | string |
| Placed document ID |
externalDirID | string |
| Directory ID (display only, not filled for CHILI Resources) |
externalName | string |
| Placed document name |
layoutID | string |
| Placed AlternateLayout ID |
layoutName | string |
| Placed Alternate Layout name |
snippetDocXML | string |
| Placed (and potentially modified, in case of inline save) snippet document XML |
snippetDocID | string |
| Places snippet document ID |
placeAsFrames | bool |
| Convert the snippet frame to frames after place |
boxes |
| Available boxes | |
box |
| Applied box | |
boxLeft | bool |
| Box left |
boxRight | bool |
| Box right |
boxTop | bool |
| Box top |
boxBottom | bool |
| Box bottom |
saveInline | bool |
| Snippet is saved inline? |
fitSnippetPercentValue | number | Fit percentage | |
useClosestAlternateLayout | bool | If true, CHILI will attempt to find the closest alternate layout in the snippet document after user's resize actions |