Information Classification: External Restricted.
See https://www.chili-publish.com/security

Document Object Model - Document

The main Document object

Fields

Name

Type

Triggers

Description

pages

Pages

 

Document's pages list

paragraphStyles

ParagraphStyles

 

Document's ParagraphStyles list

characterStyles

CharacterStyles

 

Document's CharacterStyles list

colors

Colors

 

Document's Color List (including "custom" colors, which are not displayed in the ColorList input panel)

layers

Layers

 

Document's Layers list

variables

Variables

 

Document Variable Definitions and values

fonts

Fonts

 

Document's Fonts list

alternateLayouts

AlternateLayouts

 

Document's Alternate Layout list

preflightPreferences

PreflightPreferences

 

Document's Preflight Preferences

preflightResults

PreflightResults

 

Document's Preflight Result list

bookMarks

BookMarks

 

Document's BookMarks list

adSettings

AdSettings

 

Document's AdSettings

frameConstraints

FrameConstraints

 

Applied Frame constraints on document level (all sub-levels inherit from this)

id

string

 

Document ID

name

string

 

Document name

path

string

 

Document relative path

zoom

number

 

Current document zoom (percentage)

width

unit

DocumentDimensionsChanged

Document Width

height

unit

DocumentDimensionsChanged

Document height

documentAssetDir

string

DocumentDefaultDirectoriesChanged

Document's asset directory

userAssetDir

string

DocumentDefaultDirectoriesChanged

User asset directory

userGroupAssetDir

string

DocumentDefaultDirectoriesChanged

User group asset directory

facingPages

bool

DocumentDimensionsChanged

Document contains facing pages (spreads)

bleedLeft

unit

DocumentBleedChanged

Left bleed

bleedTop

unit

DocumentBleedChanged

Top bleed

bleedRight

unit

DocumentBleedChanged

Right bleed

bleedBottom

unit

DocumentBleedChanged

Bottom bleed

slugLeft

unit

DocumentSlugChanged

Slug left

slugRight

unit

DocumentSlugChanged

Slug right

slugTop

unit

DocumentSlugChanged

Slug top

slugBottom

unit

DocumentSlugChanged

Slug bottom

flapWidth

unit

DocumentFlapChanged

Width of flaps, for book cover guides

flapWrap

unit

DocumentFlapChanged

Wrap of flaps, for book cover guides

spineWidth

unit

DocumentSpineChanged

Spine width for cover guides

spineHinge

unit

DocumentSpineChanged

Spine hinge for covor guides

constraints

DocumentConstraints

 

Document Constraints

viewPreferences

ViewPreferences

 

Document's ViewPreferences

horizontalSpine

bool

DocumentSpineChanged

Draw spine guide as horizontal rule, rather than default vertical

allowWorkSpaceChanges

bool

WorkSpaceChanged

Allow workspace administration, based on user privileges, or view simulation

commonStrings

CommonStrings

 

Placeholder object for common localized strings

importWarnings

ImportWarnings

 

Document's ImportWarnings list

initialLayout

AlternateLayout

 

Document's initially loaded Alternate Layout

savedInEditor

bool

 

If true, the document has been saved at least once in CHILI editor (rather than having been created using an external application such as the InDesign Extension). External applications which edit the document's XML should set this value to 'false' for best results.
As this property was added in version 1.1.2. documents created/saved before this version will not have the property set.

dataSource

DataSource

 

Document's DataSource Settings

frameContentConstraints

FrameContentConstraints

 

Frame content constraints on document level (all sub-levels inherit from this)

baseLineGridOptions

BaseLineGridOptions

 

Document BaseLineGrid Options

allowContentAdministration

bool

WorkSpaceChanged

Allow content administration, based on user privileges, or view simulation

simulateUser

string

WorkSpaceChanged

Simulate user view for the current editor session

textLanguage

string

 

Default text language (ID or XX System name of language)

chiliVersion

string

 

The version in which the document was last saved

eventActions

DocumentEventActions#/Cooklist/DocumentEventActions

 

Document's EventActions list

foldSettingID

string

DocumentFoldingSettingsChanged

Document's default Folding Settings ID

foldDocIdentifier

string

DocumentFoldingSettingsChanged

 

threeDModelID

string

DocumentThreeDModelChanged

Document's default Folding Settings ID

threeDModelDocIdentifier

string

DocumentThreeDModelChanged

 

maxCliTimeout

number

 

Used for timing if CLI is not responding. And to test if document loading in CLI is taking too long.

saveInactiveTextPositions

bool

 

Variable used to skip saving unused alternate layouts / pages / frames
(to increase performance)

copyFittingStyles

CopyFittingStyles#/Cooklist/CopyFittingStyles

 

Document's Copy Fitting Style list

Functions

Called from JavaScript using editor.ExecuteFunction("object_descriptor", "FUNCTION_NAME", args...)

Name

Arguments

Returns

Description

Save

 

 

Saves the document (asynchronously). When finished, the DocumentSaved event is triggered

Revert

 

 

Reverts the document to its last Saved state

PlaceContent

xml (string)

 

Ads pages and frames based on XML descriptions (see External XML in the API Guide)

SetCursor

name (CursorType)

 

Sets the current cursor

OpenDocument

docID (string)

 

Opens the new document in the existing Editor instance (without needing to relead the Editor swf)

CreateTempPDF_FromXml

[pdfSettingsXmlString (string)
targetFrame (string)#/Cooklist/pdfSettingsXmlString (string)
targetFrame (string)]

 

Initiates PDF creation within the editor, based on the temporary (unsaved) status of the current document

CreateTempImages_FromXml

[pdfSettingsXmlString (string)
imgProfileID (string)#/Cooklist/pdfSettingsXmlString (string)
imgProfileID (string)]

 

Initiates PDF creation within the editor, based on the temporary (unsaved) status of the current document

Inherits from

> DocumentBase#/Cooklist/DocumentBase

All information on this page must be treated as External Restricted, or more strict. https://www.chili-publish.com/security